symbol_edit_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) 2013 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 <bitmaps.h>
#include <wx/hyperlink.h>
#include <base_screen.h>
#include <confirm.h>
#include <core/kicad_algo.h>
#include <core/throttle.h>
#include <eeschema_id.h>
#include <eeschema_settings.h>
#include <env_paths.h>
#include <gal/graphics_abstraction_layer.h>
#include <kidialog.h>
#include <kiface_base.h>
#include <kiplatform/app.h>
#include <kiway_mail.h>
#include <symbol_edit_frame.h>
#include <lib_symbol_library_manager.h>
#include <symbol_editor/symbol_editor_settings.h>
#include <symbol_editor/symbol_editor_tab_context.h>
#include <paths.h>
#include <pgm_base.h>
#include <project_sch.h>
#include <sch_painter.h>
#include <sch_view.h>
#include <settings/color_settings.h>
#include <settings/settings_manager.h>
#include <toolbars_symbol_editor.h>
#include <tool/action_manager.h>
#include <tool/action_toolbar.h>
#include <tool/common_control.h>
#include <tool/common_tools.h>
#include <tool/editor_conditions.h>
#include <tool/embed_tool.h>
#include <tool/library_editor_control.h>
#include <tool/picker_tool.h>
#include <tool/properties_tool.h>
#include <tool/selection.h>
#include <tool/tool_dispatcher.h>
#include <tool/tool_manager.h>
#include <tool/zoom_tool.h>
#include <tools/sch_actions.h>
#include <tools/sch_inspection_tool.h>
#include <tools/sch_point_editor.h>
#include <tools/ee_grid_helper.h>
#include <tools/sch_selection_tool.h>
#include <tools/sch_find_replace_tool.h>
#include <tools/symbol_editor_control.h>
#include <tools/symbol_editor_drawing_tools.h>
#include <tools/symbol_editor_edit_tool.h>
#include <tools/symbol_editor_move_tool.h>
#include <tools/symbol_editor_pin_tool.h>
#include <view/view_controls.h>
#include <widgets/app_progress_dialog.h>
#include <widgets/wx_infobar.h>
#include <widgets/wx_progress_reporters.h>
#include <widgets/panel_sch_selection_filter.h>
#include <widgets/sch_properties_panel.h>
#include <widgets/editor_tabs_panel.h>
#include <widgets/kicad_tab_art.h>
#include <widgets/lib_tree.h>
#include <widgets/symbol_tree_pane.h>
#include <widgets/wx_aui_utils.h>
#include <widgets/filedlg_hook_new_library.h>
#include <wildcards_and_files_ext.h>
#include <panel_sym_lib_table.h>
#include <string_utils.h>
#include <libraries/symbol_library_adapter.h>
#include <wx/msgdlg.h>
#include <wx/combobox.h>
#include <wx/log.h>
#include <trace_helpers.h>
 
 
bool SYMBOL_EDIT_FRAME::m_showDeMorgan = false;
 
 
BEGIN_EVENT_TABLE( SYMBOL_EDIT_FRAME, SCH_BASE_FRAME )
    EVT_COMBOBOX( ID_LIBEDIT_SELECT_UNIT_NUMBER, SYMBOL_EDIT_FRAME::OnSelectUnit )
    EVT_COMBOBOX( ID_LIBEDIT_SELECT_BODY_STYLE, SYMBOL_EDIT_FRAME::OnSelectBodyStyle )
 
    // menubar commands
    EVT_MENU( wxID_EXIT, SYMBOL_EDIT_FRAME::OnExitKiCad )
    EVT_MENU( wxID_CLOSE, SYMBOL_EDIT_FRAME::CloseWindow )
 
    // Update user interface elements.
    EVT_UPDATE_UI( ID_LIBEDIT_SELECT_UNIT_NUMBER, SYMBOL_EDIT_FRAME::OnUpdateUnitNumber )
    EVT_UPDATE_UI( ID_LIBEDIT_SELECT_BODY_STYLE, SYMBOL_EDIT_FRAME::OnUpdateBodyStyle )
 
    EVT_CHOICE( ID_ON_ZOOM_SELECT, SYMBOL_EDIT_FRAME::OnSelectZoom )
    EVT_CHOICE( ID_ON_GRID_SELECT, SYMBOL_EDIT_FRAME::OnSelectGrid )
 
    // Drop files event
    EVT_DROP_FILES( SYMBOL_EDIT_FRAME::OnDropFiles )
 
END_EVENT_TABLE()
 
 
SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent ) :
        SCH_BASE_FRAME( aKiway, aParent, FRAME_SCH_SYMBOL_EDITOR, _( "Library Editor" ),
                        wxDefaultPosition, wxDefaultSize, KICAD_DEFAULT_DRAWFRAME_STYLE,
                        LIB_EDIT_FRAME_NAME ),
        m_unitSelectBox( nullptr ),
        m_bodyStyleSelectBox( nullptr ),
        m_isSymbolFromSchematic( false ),
        m_libTreeAutoHiddenForSchematicEdit( false )
{
    m_SyncPinEdit = false;
 
    m_symbol = nullptr;
    m_treePane = nullptr;
    m_libMgr = nullptr;
    m_unit = 1;
    m_bodyStyle = 1;
    m_syncLibrariesInProgress = false;
    m_aboutTitle = _HKI( "KiCad Symbol Editor" );
 
    wxIcon icon;
    wxIconBundle icon_bundle;
 
    icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_libedit, 48 ) );
    icon_bundle.AddIcon( icon );
    icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_libedit, 256 ) );
    icon_bundle.AddIcon( icon );
    icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_libedit, 128 ) );
    icon_bundle.AddIcon( icon );
    icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_libedit_32 ) );
    icon_bundle.AddIcon( icon );
    icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_libedit_16 ) );
    icon_bundle.AddIcon( icon );
 
    SetIcons( icon_bundle );
 
    m_settings = GetAppSettings<SYMBOL_EDITOR_SETTINGS>( "symbol_editor" );
    LoadSettings( m_settings );
 
    m_libMgr = new LIB_SYMBOL_LIBRARY_MANAGER( *this );
 
    m_treePane = new SYMBOL_TREE_PANE( this, m_libMgr );
    m_treePane->GetLibTree()->SetSortMode( (LIB_TREE_MODEL_ADAPTER::SORT_MODE) m_settings->m_LibrarySortMode );
 
    resolveCanvasType();
    SwitchCanvas( m_canvasType );
 
    // Ensure axis are always drawn
    KIGFX::GAL_DISPLAY_OPTIONS& gal_opts = GetGalDisplayOptions();
    gal_opts.m_axesEnabled = true;
 
    m_dummyScreen = new SCH_SCREEN();
    SetScreen( m_dummyScreen );
    GetScreen()->m_Center = true;
 
    GetCanvas()->GetViewControls()->SetCrossHairCursorPosition( VECTOR2D( 0, 0 ), false );
 
    GetRenderSettings()->LoadColors( GetColorSettings() );
    GetRenderSettings()->m_IsSymbolEditor = true;
    GetCanvas()->GetGAL()->SetAxesColor( m_colorSettings->GetColor( LAYER_SCHEMATIC_GRID_AXES ) );
 
    setupTools();
    setupUIConditions();
 
    ReCreateMenuBar();
 
    m_toolbarSettings = GetToolbarSettings<SYMBOL_EDIT_TOOLBAR_SETTINGS>( "symbol_editor-toolbars" );
    configureToolbars();
    RecreateToolbars();
 
    UpdateTitle();
    UpdateSymbolMsgPanelInfo();
    RebuildSymbolUnitAndBodyStyleLists();
 
    m_propertiesPanel = new SCH_PROPERTIES_PANEL( this, this );
    m_propertiesPanel->SetSplitterProportion( m_settings->m_AuiPanels.properties_splitter );
 
    m_selectionFilterPanel = new PANEL_SCH_SELECTION_FILTER( this );
 
    m_auimgr.SetManagedWindow( this );
 
    CreateInfoBar();
 
    // Rows; layers 4 - 6
    m_auimgr.AddPane( m_tbTopMain, EDA_PANE().HToolbar().Name( "TopMainToolbar" )
                      .Top().Layer( 6 ) );
 
    m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" )
                      .Bottom().Layer( 6 ) );
 
    m_auimgr.AddPane( m_tbLeft, EDA_PANE().VToolbar().Name( "LeftToolbar" )
                      .Left().Layer( 2 ) );
 
    m_auimgr.AddPane( m_tbRight, EDA_PANE().VToolbar().Name( "RightToolbar" )
                      .Right().Layer( 2 ) );
 
    m_tabsPanel = new EDITOR_TABS_PANEL( this, GetCanvas() );
 
    m_tabsPanel->onActivateTab =
            [this]( int aIdx )
            {
                if( SYMBOL_EDITOR_TAB_CONTEXT* ctx = symbolTabContextForIndex( aIdx ) )
                    activateSymbolTab( ctx );
            };
 
    m_tabsPanel->onCloseTabRequested =
            [this]( int aIdx ) -> bool
            {
                return promptAndCloseSymbolTab( aIdx );
            };
 
    m_tabsPanel->onQueryVisualState =
            [this]( int aIdx ) -> TAB_VISUAL_STATE
            {
                // The panel model owns preview. Read modified from the live context.
                const std::vector<EDITOR_TABS_MODEL::ENTRY>& entries = m_tabsPanel->Model().Entries();
 
                if( aIdx < 0 || aIdx >= static_cast<int>( entries.size() ) )
                    return TAB_VISUAL_STATE{};
 
                const SYMBOL_EDITOR_TAB_CONTEXT* ctx = symbolTabContextForIndex( aIdx );
                const bool modified = ctx ? ctx->IsModified() : entries[aIdx].modified;
 
                return ResolveTabVisualState( entries[aIdx].preview, modified );
            };
 
    m_auimgr.AddPane( m_tabsPanel, wxAuiPaneInfo().Name( "DrawFrame" )
                      .CentrePane() );
 
    // Columns; layers 1 - 3
    m_auimgr.AddPane( m_treePane, EDA_PANE().Palette().Name( "LibraryTree" )
                      .Left().Layer( 3 )
                      .TopDockable( false ).BottomDockable( false )
                      .Caption( _( "Libraries" ) )
                      // Don't use -1 for don't-change-height on a growable panel; it has side-effects.
                      .MinSize( FromDIP( 250 ), FromDIP( 80 ) )
                      .BestSize( FromDIP( 250 ), -1 ) );
 
    m_auimgr.AddPane( m_propertiesPanel, defaultPropertiesPaneInfo( this ) );
    m_auimgr.AddPane( m_selectionFilterPanel, defaultSchSelectionFilterPaneInfo( this ) );
 
    // Can be called only when all panes are created, because (at least on Windows) when items
    // managed by m_auimgr are not the same as those existing when saved by Perspective()
    // in config, broken settings can happen.
    RestoreAuiLayout();
 
    // Protect against broken saved Perspective() due to bugs in previous version
    // This is currently a workaround.
    m_auimgr.GetPane( "TopMainToolbar" ).Top().Layer( 6 ).Position(0).Show( true );
    m_auimgr.GetPane( "LeftToolbar" ).Position(0).Show( true );
    m_auimgr.GetPane( "RightToolbar" ).Show( true );
 
    // Show or hide m_propertiesPanel depending on current settings:
    wxAuiPaneInfo& propertiesPaneInfo = m_auimgr.GetPane( PropertiesPaneName() );
    wxAuiPaneInfo& selectionFilterPane = m_auimgr.GetPane( wxS( "SelectionFilter" ) );
    // The selection filter doesn't need to grow in the vertical direction when docked
    selectionFilterPane.dock_proportion = 0;
 
    propertiesPaneInfo.Show( m_settings->m_AuiPanels.show_properties );
    updateSelectionFilterVisbility();
 
    FinishAUIInitialization();
 
    // Can't put this in LoadSettings, because it has to be called before setupTools :/
    SCH_SELECTION_TOOL* selTool = GetToolManager()->GetTool<SCH_SELECTION_TOOL>();
    selTool->GetFilter() = GetSettings()->m_SelectionFilter;
    m_selectionFilterPanel->SetCheckboxesFromFilter( selTool->GetFilter() );
 
    if( m_settings->m_LibWidth > 0 )
        SetAuiPaneSize( m_auimgr, m_auimgr.GetPane( "LibraryTree" ), m_settings->m_LibWidth, -1 );
 
    Raise();
    Show( true );
 
    SyncView();
    GetCanvas()->GetView()->UseDrawPriority( true );
    GetCanvas()->GetGAL()->SetAxesEnabled( true );
 
    setupUnits( m_settings );
 
    // Set the working/draw area size to display a symbol to a reasonable value:
    // A 600mm x 600mm with a origin at the area center looks like a large working area
    double max_size_x = schIUScale.mmToIU( 600 );
    double max_size_y = schIUScale.mmToIU( 600 );
    BOX2D bbox;
    bbox.SetOrigin( -max_size_x /2, -max_size_y/2 );
    bbox.SetSize( max_size_x, max_size_y );
    GetCanvas()->GetView()->SetBoundary( bbox );
 
    m_toolManager->RunAction( ACTIONS::zoomFitScreen );
 
    m_acceptedExts.emplace( FILEEXT::KiCadSymbolLibFileExtension, &ACTIONS::ddAddLibrary );
    DragAcceptFiles( true );
 
    KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Library changes are unsaved" ) );
 
    // Catch unhandled accelerator command characters that were no handled by the library tree
    // panel.
    Bind( wxEVT_CHAR, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
    Bind( wxEVT_CHAR_HOOK, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
 
    // GTK rejects WXK_TAB as an accelerator so cycle tabs from the char hook ahead of the dispatcher.
    Bind( wxEVT_CHAR_HOOK, &SYMBOL_EDIT_FRAME::OnTabCharHook, this );
 
    // Ensure the window is on top
    Raise();
 
    // run SyncLibraries with progress reporter enabled. The progress reporter is useful
    // in debug mode because the loading time of ecah library can be really noticeable
    SyncLibraries( true );
 
    // Must follow SyncLibraries so persisted tabs can resolve against the loaded libraries.
    restoreSymbolTabsFromSettings();
}
 
 
SYMBOL_EDIT_FRAME::~SYMBOL_EDIT_FRAME()
{
    // Hand the borrowed canvas back before the base destructor frees it, else the panel reparents
    // freed memory on its own teardown.
    if( m_tabsPanel )
        m_tabsPanel->ReleaseSharedCanvas();
 
    // Shutdown all running tools
    if( m_toolManager )
        m_toolManager->ShutdownAllTools();
 
    setSymWatcher( nullptr );
 
    if( m_activeTab )
    {
        // Hand the working objects back so the context deletes them exactly once below; raw deleting
        // here would double-free with the context dtor and leak the swapped-in undo list. Covers an
        // active instance tab too, whose m_isSymbolFromSchematic mirror is only frame state.
        ClearUndoRedoList();
        m_activeTab->AdoptWorkingObjects( m_symbol, static_cast<SCH_SCREEN*>( GetScreen() ) );
        m_activeTab = nullptr;
        m_symbol = nullptr;
        SetScreen( m_dummyScreen );
    }
    else
    {
        // No active tab owns the current screen, so let EDA_DRAW_FRAME free it.
        SetScreen( m_dummyScreen );
    }
 
    // Free each detached context's undo/redo with the frame on the dummy screen to avoid double-frees.
    for( const std::unique_ptr<SYMBOL_EDITOR_TAB_CONTEXT>& ctx : m_tabContexts )
        clearSymbolTabUndoRedo( *ctx );
 
    m_tabContexts.clear();
 
    if( SYMBOL_EDITOR_SETTINGS* cfg = GetAppSettings<SYMBOL_EDITOR_SETTINGS>( "symbol_editor" ) )
        Pgm().GetSettingsManager().Save( cfg );
 
    delete m_libMgr;
}
 
 
void SYMBOL_EDIT_FRAME::LoadSettings( APP_SETTINGS_BASE* aCfg )
{
    wxCHECK_RET( m_settings, "Call to SYMBOL_EDIT_FRAME::LoadSettings with null m_settings" );
 
    SCH_BASE_FRAME::LoadSettings( GetSettings() );
 
    GetRenderSettings()->m_ShowPinsElectricalType = m_settings->m_ShowPinElectricalType;
    GetRenderSettings()->m_ShowHiddenPins = m_settings->m_ShowHiddenPins;
    GetRenderSettings()->m_ShowHiddenFields = m_settings->m_ShowHiddenFields;
    GetRenderSettings()->m_ShowPinAltIcons = m_settings->m_ShowPinAltIcons;
    GetRenderSettings()->SetDefaultFont( wxEmptyString );
}
 
 
void SYMBOL_EDIT_FRAME::SaveSettings( APP_SETTINGS_BASE* aCfg )
{
    wxCHECK_RET( m_settings, "Call to SYMBOL_EDIT_FRAME:SaveSettings with null m_settings" );
 
    GetGalDisplayOptions().m_axesEnabled = true;
 
    // The library tree is hidden while editing a symbol from the schematic. Force it visible in the
    // serialized AUI layout so the user's preference survives a restart, but only touch the pane
    // metadata (not ToggleLibraryTree) to avoid a mid-session repaint/flicker and a spurious tree
    // width capture below.
    wxAuiPaneInfo& treePane = m_auimgr.GetPane( m_treePane );
    wxAuiPaneInfo& filterPane = m_auimgr.GetPane( wxS( "SelectionFilter" ) );
 
    const bool treeShown = treePane.IsShown();
    const bool filterShown = filterPane.IsShown();
 
    // Gate on the pending-restore flag alone, not the active-tab schematic state, which is cleared
    // when a schematic tab closes while the tree stays auto-hidden.
    const bool forceTreeShown = m_libTreeAutoHiddenForSchematicEdit && !treeShown;
 
    if( forceTreeShown )
    {
        treePane.Show( true );
        updateSelectionFilterVisbility();
    }
 
    SCH_BASE_FRAME::SaveSettings( GetSettings() );
 
    if( forceTreeShown )
    {
        treePane.Show( treeShown );
        filterPane.Show( filterShown );
    }
 
    m_settings->m_ShowPinElectricalType  = GetRenderSettings()->m_ShowPinsElectricalType;
    m_settings->m_ShowHiddenPins = GetRenderSettings()->m_ShowHiddenPins;
    m_settings->m_ShowHiddenFields = GetRenderSettings()->m_ShowHiddenFields;
    m_settings->m_ShowPinAltIcons = GetRenderSettings()->m_ShowPinAltIcons;
 
    m_settings->m_LibWidth = m_treePane->GetSize().x;
 
    m_settings->m_LibrarySortMode = GetLibTree()->GetSortMode();
 
    m_settings->m_AuiPanels.properties_splitter = m_propertiesPanel->SplitterProportion();
    bool prop_shown = m_auimgr.GetPane( PropertiesPaneName() ).IsShown();
    m_settings->m_AuiPanels.show_properties = prop_shown;
 
    if( TOOL_MANAGER* toolMgr = GetToolManager() )
    {
        if( SCH_SELECTION_TOOL* selTool = toolMgr->GetTool<SCH_SELECTION_TOOL>() )
            m_settings->m_SelectionFilter = selTool->GetFilter();
    }
 
    storeSymbolTabsToSettings();
}
 
 
APP_SETTINGS_BASE* SYMBOL_EDIT_FRAME::config() const
{
    return static_cast<APP_SETTINGS_BASE*>( GetSettings() );
}
 
 
COLOR_SETTINGS* SYMBOL_EDIT_FRAME::GetColorSettings( bool aForceRefresh ) const
{
    APP_SETTINGS_BASE* cfg = GetSettings();
 
    if( cfg && static_cast<SYMBOL_EDITOR_SETTINGS*>( cfg )->m_UseEeschemaColorSettings )
        cfg = GetAppSettings<EESCHEMA_SETTINGS>( "eeschema" );
 
    return ::GetColorSettings( cfg ? cfg->m_ColorTheme : DEFAULT_THEME );
}
 
 
void SYMBOL_EDIT_FRAME::setupTools()
{
    // Create the manager and dispatcher & route draw panel events to the dispatcher
    m_toolManager = new TOOL_MANAGER;
    m_toolManager->SetEnvironment( GetScreen(), GetCanvas()->GetView(),
                                   GetCanvas()->GetViewControls(), GetSettings(), this );
    m_actions = new SCH_ACTIONS();
    m_toolDispatcher = new TOOL_DISPATCHER( m_toolManager );
 
    // Register tools
    m_toolManager->RegisterTool( new COMMON_CONTROL );
    m_toolManager->RegisterTool( new COMMON_TOOLS );
    m_toolManager->RegisterTool( new ZOOM_TOOL );
    m_toolManager->RegisterTool( new SCH_SELECTION_TOOL );
    m_toolManager->RegisterTool( new PICKER_TOOL );
    m_toolManager->RegisterTool( new SCH_INSPECTION_TOOL );
    m_toolManager->RegisterTool( new SYMBOL_EDITOR_PIN_TOOL );
    m_toolManager->RegisterTool( new SYMBOL_EDITOR_DRAWING_TOOLS );
    m_toolManager->RegisterTool( new SCH_POINT_EDITOR );
    m_toolManager->RegisterTool( new SCH_FIND_REPLACE_TOOL );
    m_toolManager->RegisterTool( new SYMBOL_EDITOR_MOVE_TOOL );
    m_toolManager->RegisterTool( new SYMBOL_EDITOR_EDIT_TOOL );
    m_toolManager->RegisterTool( new LIBRARY_EDITOR_CONTROL );
    m_toolManager->RegisterTool( new SYMBOL_EDITOR_CONTROL );
    m_toolManager->RegisterTool( new PROPERTIES_TOOL );
    m_toolManager->RegisterTool( new EMBED_TOOL );
    m_toolManager->InitTools();
 
    // Run the selection tool, it is supposed to be always active
    m_toolManager->InvokeTool( "common.InteractiveSelection" );
 
    GetCanvas()->SetEventDispatcher( m_toolDispatcher );
}
 
 
void SYMBOL_EDIT_FRAME::setupUIConditions()
{
    SCH_BASE_FRAME::setupUIConditions();
 
    ACTION_MANAGER*   mgr = m_toolManager->GetActionManager();
    EDITOR_CONDITIONS cond( this );
 
    wxASSERT( mgr );
 
#define ENABLE( x ) ACTION_CONDITIONS().Enable( x )
#define CHECK( x )  ACTION_CONDITIONS().Check( x )
 
    auto haveSymbolCond =
            [this]( const SELECTION& )
            {
                return m_symbol;
            };
 
    auto isEditableCond =
            [this]( const SELECTION& )
            {
                // Only root symbols from the new s-expression libraries or the schematic
                // are editable.
                return IsSymbolEditable() && !IsSymbolAlias();
            };
 
    auto isEditableInAliasCond =
            [this]( const SELECTION& )
            {
                // Less restrictive than isEditableCond
                // Symbols fields (root symbols and aliases) from the new s-expression libraries
                // or in the schematic are editable.
                return IsSymbolEditable();
            };
 
    auto symbolModifiedCondition =
            [this]( const SELECTION& sel )
            {
                return m_libMgr && m_libMgr->IsSymbolModified( GetTargetLibId().GetLibItemName(),
                                                               GetTargetLibId().GetLibNickname() );
            };
 
    auto libSelectedCondition =
            [this]( const SELECTION& sel )
            {
                return !GetTargetLibId().GetLibNickname().empty();
            };
 
    auto canEditProperties =
            [this]( const SELECTION& sel )
            {
                return m_symbol && ( !IsSymbolFromLegacyLibrary() || IsSymbolFromSchematic() );
            };
 
    auto symbolSelectedInTreeCondition =
            [this]( const SELECTION& sel )
            {
                LIB_ID targetLibId = GetTargetLibId();
                return !targetLibId.GetLibNickname().empty() && !targetLibId.GetLibItemName().empty();
            };
 
    auto saveSymbolAsCondition =
            [this]( const SELECTION& aSel )
            {
                return getTargetSymbol() != nullptr;
            };
 
    const auto isSymbolFromSchematicCond =
            [this]( const SELECTION& )
            {
                return IsSymbolFromSchematic();
            };
 
    // clang-format off
    mgr->SetConditions( ACTIONS::saveAll,                       ENABLE( SELECTION_CONDITIONS::ShowAlways ) );
    mgr->SetConditions( ACTIONS::save,                          ENABLE( SELECTION_CONDITIONS::ShowAlways ) );
    mgr->SetConditions( SCH_ACTIONS::saveLibraryAs,             ENABLE( libSelectedCondition ) );
    mgr->SetConditions( SCH_ACTIONS::saveSymbolAs,              ENABLE( saveSymbolAsCondition ) );
    mgr->SetConditions( SCH_ACTIONS::saveSymbolCopyAs,          ENABLE( saveSymbolAsCondition ) );
    mgr->SetConditions( SCH_ACTIONS::newSymbol,                 ENABLE( SELECTION_CONDITIONS::ShowAlways ) );
    mgr->SetConditions( SCH_ACTIONS::importSymbol,              ENABLE( SELECTION_CONDITIONS::ShowAlways ) );
    mgr->SetConditions( SCH_ACTIONS::editLibSymbolWithLibEdit,  ENABLE( isSymbolFromSchematicCond ) );
 
    mgr->SetConditions( ACTIONS::undo,                ENABLE( haveSymbolCond && cond.UndoAvailable() ) );
    mgr->SetConditions( ACTIONS::redo,                ENABLE( haveSymbolCond && cond.RedoAvailable() ) );
    mgr->SetConditions( ACTIONS::revert,              ENABLE( symbolModifiedCondition ) );
 
    mgr->SetConditions( ACTIONS::toggleGrid,          CHECK( cond.GridVisible() ) );
    mgr->SetConditions( ACTIONS::toggleGridOverrides, CHECK( cond.GridOverrides() ) );
 
    mgr->SetConditions( ACTIONS::cut,                 ENABLE( isEditableCond ) );
    mgr->SetConditions( ACTIONS::copy,                ENABLE( haveSymbolCond ) );
    mgr->SetConditions( ACTIONS::copyAsText,          ENABLE( haveSymbolCond ) );
    mgr->SetConditions( ACTIONS::paste,               ENABLE( isEditableCond &&
                                                              SELECTION_CONDITIONS::Idle && cond.NoActiveTool() ) );
    mgr->SetConditions( ACTIONS::doDelete,            ENABLE( isEditableCond ) );
    mgr->SetConditions( ACTIONS::duplicate,           ENABLE( isEditableCond ) );
    mgr->SetConditions( ACTIONS::selectAll,           ENABLE( haveSymbolCond ) );
    mgr->SetConditions( ACTIONS::unselectAll,         ENABLE( haveSymbolCond ) );
 
    // These actions in symbol editor when editing alias field rotations are allowed.
    mgr->SetConditions( SCH_ACTIONS::rotateCW,
                        ENABLE( SELECTION_CONDITIONS::NotEmpty && isEditableInAliasCond )
                        .HotkeyEnable( isEditableInAliasCond ) );
    mgr->SetConditions( SCH_ACTIONS::rotateCCW,
                        ENABLE( SELECTION_CONDITIONS::NotEmpty && isEditableInAliasCond )
                        .HotkeyEnable( isEditableInAliasCond ) );
 
    mgr->SetConditions( SCH_ACTIONS::mirrorH,
                        ENABLE( SELECTION_CONDITIONS::NotEmpty && isEditableCond )
                        .HotkeyEnable( isEditableCond ) );
    mgr->SetConditions( SCH_ACTIONS::mirrorV,
                        ENABLE( SELECTION_CONDITIONS::NotEmpty && isEditableCond )
                        .HotkeyEnable( isEditableCond ) );
 
    mgr->SetConditions( ACTIONS::zoomTool,            CHECK( cond.CurrentTool( ACTIONS::zoomTool ) ) );
    mgr->SetConditions( ACTIONS::selectionTool,       CHECK( cond.CurrentTool( ACTIONS::selectionTool ) ) );
    // clang-format on
 
    auto pinTypeCond =
            [this]( const SELECTION& )
            {
                return libeditconfig()->m_ShowPinElectricalType;
            };
 
    auto hiddenPinCond =
            [this]( const SELECTION& )
            {
                return libeditconfig()->m_ShowHiddenPins;
            };
 
    auto hiddenFieldCond =
            [this]( const SELECTION& )
            {
                return libeditconfig()->m_ShowHiddenFields;
            };
 
    auto showPinAltIconsCond =
            [this]( const SELECTION& )
            {
                return libeditconfig()->m_ShowPinAltIcons;
            };
 
    auto showLibraryTreeCond =
            [this]( const SELECTION& )
            {
                return IsLibraryTreeShown();
            };
 
    auto propertiesCond =
            [this] ( const SELECTION& )
            {
                return m_auimgr.GetPane( PropertiesPaneName() ).IsShown();
            };
 
    mgr->SetConditions( SCH_ACTIONS::showElectricalTypes, CHECK( pinTypeCond ) );
    mgr->SetConditions( ACTIONS::toggleBoundingBoxes,     CHECK( cond.BoundingBoxes() ) );
    mgr->SetConditions( ACTIONS::showLibraryTree,         CHECK( showLibraryTreeCond ) );
    mgr->SetConditions( ACTIONS::showProperties,          CHECK( propertiesCond ) );
    mgr->SetConditions( SCH_ACTIONS::showHiddenPins,      CHECK( hiddenPinCond ) );
    mgr->SetConditions( SCH_ACTIONS::showHiddenFields,    CHECK( hiddenFieldCond ) );
    mgr->SetConditions( SCH_ACTIONS::togglePinAltIcons,   CHECK( showPinAltIconsCond ) );
 
    auto multiUnitModeCond =
            [this]( const SELECTION& )
            {
                return m_symbol && m_symbol->IsMultiUnit() && !m_symbol->UnitsLocked();
            };
 
    auto multiBodyStyleModeCond =
            [this]( const SELECTION& )
            {
                return m_symbol && m_symbol->IsMultiBodyStyle();
            };
 
    auto syncedPinsModeCond =
            [this]( const SELECTION& )
            {
                return m_SyncPinEdit;
            };
 
    auto haveDatasheetCond =
            [this]( const SELECTION& )
            {
                return m_symbol && !m_symbol->GetDatasheetField().GetText().IsEmpty();
            };
 
    mgr->SetConditions( ACTIONS::showDatasheet,            ENABLE( haveDatasheetCond ) );
    mgr->SetConditions( SCH_ACTIONS::symbolProperties,     ENABLE( symbolSelectedInTreeCondition || ( canEditProperties && haveSymbolCond ) ) );
    mgr->SetConditions( SCH_ACTIONS::runERC,               ENABLE( haveSymbolCond ) );
    mgr->SetConditions( SCH_ACTIONS::pinTable,             ENABLE( isEditableCond && haveSymbolCond ) );
    mgr->SetConditions( SCH_ACTIONS::editSymbolPinMaps, ENABLE( isEditableCond && haveSymbolCond ) );
    mgr->SetConditions( SCH_ACTIONS::updateSymbolFields,   ENABLE( isEditableCond && haveSymbolCond ) );
    mgr->SetConditions( SCH_ACTIONS::cycleBodyStyle,       ENABLE( multiBodyStyleModeCond ) );
 
    mgr->SetConditions( SCH_ACTIONS::toggleSyncedPinsMode, ACTION_CONDITIONS().Enable( multiUnitModeCond ).Check( syncedPinsModeCond ) );
 
// Only enable a tool if the symbol is edtable
#define EDIT_TOOL( tool ) ACTION_CONDITIONS().Enable( isEditableCond ).Check( cond.CurrentTool( tool ) )
 
    mgr->SetConditions( ACTIONS::deleteTool,             EDIT_TOOL( ACTIONS::deleteTool ) );
    mgr->SetConditions( SCH_ACTIONS::placeSymbolPin,     EDIT_TOOL( SCH_ACTIONS::placeSymbolPin ) );
    mgr->SetConditions( SCH_ACTIONS::placeSymbolText,    EDIT_TOOL( SCH_ACTIONS::placeSymbolText ) );
    mgr->SetConditions( SCH_ACTIONS::drawSymbolTextBox,  EDIT_TOOL( SCH_ACTIONS::drawSymbolTextBox ) );
    mgr->SetConditions( SCH_ACTIONS::drawRectangle,      EDIT_TOOL( SCH_ACTIONS::drawRectangle ) );
    mgr->SetConditions( SCH_ACTIONS::drawCircle,         EDIT_TOOL( SCH_ACTIONS::drawCircle ) );
    mgr->SetConditions( SCH_ACTIONS::drawEllipse, EDIT_TOOL( SCH_ACTIONS::drawEllipse ) );
    mgr->SetConditions( SCH_ACTIONS::drawEllipseArc, EDIT_TOOL( SCH_ACTIONS::drawEllipseArc ) );
    mgr->SetConditions( SCH_ACTIONS::drawArc,            EDIT_TOOL( SCH_ACTIONS::drawArc ) );
    mgr->SetConditions( SCH_ACTIONS::drawBezier,         EDIT_TOOL( SCH_ACTIONS::drawBezier ) );
    mgr->SetConditions( SCH_ACTIONS::drawSymbolLines,    EDIT_TOOL( SCH_ACTIONS::drawSymbolLines ) );
    mgr->SetConditions( SCH_ACTIONS::drawSymbolPolygon,  EDIT_TOOL( SCH_ACTIONS::drawSymbolPolygon ) );
    mgr->SetConditions( SCH_ACTIONS::placeSymbolAnchor,  EDIT_TOOL( SCH_ACTIONS::placeSymbolAnchor ) );
    mgr->SetConditions( SCH_ACTIONS::importGraphics,     EDIT_TOOL( SCH_ACTIONS::importGraphics ) );
 
#undef CHECK
#undef ENABLE
#undef EDIT_TOOL
}
 
 
bool SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic( bool doClose )
{
    if( IsContentModified() )
    {
        SCH_EDIT_FRAME* schframe = (SCH_EDIT_FRAME*) Kiway().Player( FRAME_SCH, false );
        wxString        msg = _( "Save changes to '%s' before closing?" );
 
        switch( UnsavedChangesDialog( this, wxString::Format( msg, m_reference ), nullptr ) )
        {
        case wxID_YES:
            if( schframe && GetCurSymbol() )  // Should be always the case
                schframe->SaveSymbolToSchematic( *GetCurSymbol(), m_schematicSymbolUUID );
 
            break;
 
        case wxID_NO:
            break;
 
        default:
        case wxID_CANCEL:
            return false;
        }
    }
 
    if( doClose )
    {
        SetCurSymbol( nullptr, false );
        UpdateTitle();
    }
 
    return true;
}
 
 
bool SYMBOL_EDIT_FRAME::canCloseWindow( wxCloseEvent& aEvent )
{
    // Shutdown blocks must be determined and vetoed as early as possible, before any modal prompt.
    // IsContentModified only sees the active tab, so also account for dirty inactive instance tabs.
    if( KIPLATFORM::APP::SupportsShutdownBlockReason()
            && aEvent.GetId() == wxEVT_QUERY_END_SESSION
            && ( IsContentModified() || hasDirtyInactiveInstanceTabs() ) )
    {
        return false;
    }
 
    if( m_isSymbolFromSchematic && !CanCloseSymbolFromSchematic( false ) )
        return false;
 
    // Prompt for any dirty inactive instance tabs, which the active-tab checks above miss.
    if( !promptToSaveInactiveInstanceTabs() )
        return false;
 
    if( !saveAllLibraries( true ) )
        return false;
 
    // Save symbol tree column widths
    m_libMgr->GetAdapter()->SaveSettings();
 
    return true;
}
 
 
void SYMBOL_EDIT_FRAME::doCloseWindow()
{
    SCH_BASE_FRAME::doCloseWindow();
 
    if( GetLibTree() )
        GetLibTree()->ShutdownPreviews();
 
    delete m_toolManager;
    m_toolManager = nullptr;
 
    Destroy();
}
 
 
void SYMBOL_EDIT_FRAME::RebuildSymbolUnitAndBodyStyleLists()
{
    if( m_unitSelectBox )
    {
        if( m_unitSelectBox->GetCount() != 0 )
            m_unitSelectBox->Clear();
 
        if( !m_symbol || m_symbol->GetUnitCount() <= 1 )
        {
            m_unit = 1;
            m_unitSelectBox->Append( wxEmptyString );
        }
        else
        {
            for( int i = 0; i < m_symbol->GetUnitCount(); i++ )
                m_unitSelectBox->Append( m_symbol->GetUnitDisplayName( i + 1, true ) );
        }
 
        // Ensure the selected unit is compatible with the number of units of the current symbol:
        if( m_symbol && m_symbol->GetUnitCount() < m_unit )
            m_unit = 1;
 
        m_unitSelectBox->SetSelection( ( m_unit > 0 ) ? m_unit - 1 : 0 );
    }
 
    if( m_bodyStyleSelectBox )
    {
        if( m_bodyStyleSelectBox->GetCount() != 0 )
            m_bodyStyleSelectBox->Clear();
 
        if( !m_symbol || !m_symbol->IsMultiBodyStyle() )
        {
            m_bodyStyle = 1;
            m_bodyStyleSelectBox->Append( wxEmptyString );
        }
        else if( m_symbol && m_symbol->HasDeMorganBodyStyles() )
        {
            m_bodyStyleSelectBox->Append( wxGetTranslation( DEMORGAN_STD ) );
            m_bodyStyleSelectBox->Append( wxGetTranslation( DEMORGAN_ALT ) );
        }
        else
        {
            for( int i = 0; i < m_symbol->GetBodyStyleCount(); i++ )
                m_bodyStyleSelectBox->Append( m_symbol->GetBodyStyleNames()[i] );
        }
 
        // Ensure the selected body style is compatible with the number of body styles of the current symbol:
        if( m_symbol && m_symbol->GetBodyStyleCount() < m_bodyStyle )
            m_bodyStyle = 1;
 
        m_bodyStyleSelectBox->SetSelection( ( m_bodyStyle > 0 ) ? m_bodyStyle - 1 : 0 );
    }
}
 
 
void SYMBOL_EDIT_FRAME::ToggleProperties()
{
    if( !m_propertiesPanel )
        return;
 
    bool show = !m_propertiesPanel->IsShownOnScreen();
 
    wxAuiPaneInfo& propertiesPaneInfo = m_auimgr.GetPane( PropertiesPaneName() );
    propertiesPaneInfo.Show( show );
    updateSelectionFilterVisbility();
 
    if( show )
    {
        SetAuiPaneSize( m_auimgr, propertiesPaneInfo,
                        m_settings->m_AuiPanels.properties_panel_width, -1 );
    }
    else
    {
        m_settings->m_AuiPanels.properties_panel_width = m_propertiesPanel->GetSize().x;
    }
 
    m_auimgr.Update();
    Refresh();
}
 
 
void SYMBOL_EDIT_FRAME::ToggleLibraryTree()
{
    // An explicit toggle makes the live visibility authoritative, so drop any pending restore that
    // LoadSymbolFromSchematic's auto-hide left behind.
    m_libTreeAutoHiddenForSchematicEdit = false;
 
    wxAuiPaneInfo& treePane = m_auimgr.GetPane( m_treePane );
    treePane.Show( !IsLibraryTreeShown() );
    updateSelectionFilterVisbility();
    m_auimgr.Update();
    Refresh();
}
 
 
bool SYMBOL_EDIT_FRAME::IsLibraryTreeShown() const
{
    return const_cast<wxAuiManager&>( m_auimgr ).GetPane( m_treePane ).IsShown();
}
 
 
void SYMBOL_EDIT_FRAME::FocusLibraryTreeInput()
{
    GetLibTree()->FocusSearchFieldIfExists();
}
 
 
void SYMBOL_EDIT_FRAME::FreezeLibraryTree()
{
    m_treePane->Freeze();
    m_libMgr->GetAdapter()->Freeze();
}
 
 
void SYMBOL_EDIT_FRAME::ThawLibraryTree()
{
    m_libMgr->GetAdapter()->Thaw();
    m_treePane->Thaw();
}
 
 
void SYMBOL_EDIT_FRAME::OnExitKiCad( wxCommandEvent& event )
{
    Kiway().OnKiCadExit();
}
 
 
void SYMBOL_EDIT_FRAME::OnUpdateUnitNumber( wxUpdateUIEvent& event )
{
    event.Enable( m_symbol && m_symbol->GetUnitCount() > 1 );
}
 
 
void SYMBOL_EDIT_FRAME::OnSelectUnit( wxCommandEvent& event )
{
    if( event.GetSelection() == wxNOT_FOUND )
        return;
 
    SetUnit( event.GetSelection() + 1 );
}
 
 
void SYMBOL_EDIT_FRAME::OnUpdateBodyStyle( wxUpdateUIEvent& event )
{
    event.Enable( m_symbol && m_symbol->GetBodyStyleCount() > 1 );
}
 
 
void SYMBOL_EDIT_FRAME::OnSelectBodyStyle( wxCommandEvent& event )
{
    if( event.GetSelection() == wxNOT_FOUND )
        return;
 
    SetBodyStyle( event.GetSelection() + 1 );
}
 
 
bool SYMBOL_EDIT_FRAME::IsSymbolFromLegacyLibrary() const
{
    if( m_symbol )
    {
        SYMBOL_LIBRARY_ADAPTER* adapter = PROJECT_SCH::SymbolLibAdapter( &Prj() );
 
        if( auto row = adapter->GetRow( m_symbol->GetLibNickname() ); row.has_value() )
        {
            if( ( *row )->Type() == SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY ) )
                return true;
        }
    }
 
    return false;
}
 
 
wxString SYMBOL_EDIT_FRAME::GetCurLib() const
{
    wxString libNickname = Prj().GetRString( PROJECT::SCH_LIBEDIT_CUR_LIB );
 
    if( !libNickname.empty() )
    {
        if( !PROJECT_SCH::SymbolLibAdapter( &Prj() )->HasLibrary( libNickname ) )
        {
            Prj().SetRString( PROJECT::SCH_LIBEDIT_CUR_LIB, wxEmptyString );
            libNickname = wxEmptyString;
        }
    }
 
    return libNickname;
}
 
 
wxString SYMBOL_EDIT_FRAME::SetCurLib( const wxString& aLibNickname )
{
    wxString old = GetCurLib();
 
    if( aLibNickname.empty() || !PROJECT_SCH::SymbolLibAdapter( &Prj() )->HasLibrary( aLibNickname ) )
        Prj().SetRString( PROJECT::SCH_LIBEDIT_CUR_LIB, wxEmptyString );
    else
        Prj().SetRString( PROJECT::SCH_LIBEDIT_CUR_LIB, aLibNickname );
 
    return old;
}
 
 
void SYMBOL_EDIT_FRAME::SetCurSymbol( LIB_SYMBOL* aSymbol, bool aUpdateZoom )
{
    wxCHECK( m_toolManager, /* void */ );
 
    m_toolManager->RunAction( ACTIONS::selectionClear );
    GetCanvas()->GetView()->Clear();
 
    // Install the replacement and refresh the active context before freeing the old symbol, so the
    // context never observes a freed pointer.
    LIB_SYMBOL* oldSymbol = m_symbol;
 
    m_symbol = aSymbol;
 
    if( m_activeTab )
        m_activeTab->RefreshFrameOwnedObjects( m_symbol, static_cast<SCH_SCREEN*>( GetScreen() ) );
 
    delete oldSymbol;
 
    // select the current symbol in the tree widget
    if( !IsSymbolFromSchematic() && m_symbol )
        GetLibTree()->SelectLibId( m_symbol->GetLibId() );
    else
        GetLibTree()->Unselect();
 
    wxString symbolName;
    wxString libName;
 
    if( m_symbol )
    {
        symbolName = m_symbol->GetName();
        libName = UnescapeString( m_symbol->GetLibId().GetLibNickname() );
    }
 
    // retain in case this wxFrame is re-opened later on the same PROJECT
    Prj().SetRString( PROJECT::SCH_LIBEDIT_CUR_SYMBOL, symbolName );
 
    // Ensure synchronized pin edit can be enabled only symbols with interchangeable units
    m_SyncPinEdit = aSymbol && aSymbol->IsRoot() && aSymbol->IsMultiUnit() && !aSymbol->UnitsLocked();
 
    m_toolManager->ResetTools( TOOL_BASE::MODEL_RELOAD );
 
    GetRenderSettings()->m_ShowUnit = m_unit;
    GetRenderSettings()->m_ShowBodyStyle = m_bodyStyle;
    GetRenderSettings()->m_ShowDisabled = IsSymbolFromLegacyLibrary() && !IsSymbolFromSchematic();
    GetRenderSettings()->m_ShowGraphicsDisabled = IsSymbolAlias() && !IsSymbolFromSchematic();
    GetCanvas()->DisplaySymbol( m_symbol );
    GetCanvas()->GetView()->HideDrawingSheet();
    GetCanvas()->GetView()->ClearHiddenFlags();
 
    if( aUpdateZoom )
        m_toolManager->RunAction( ACTIONS::zoomFitScreen );
 
    GetCanvas()->Refresh();
    m_propertiesPanel->UpdateData();
 
    WX_INFOBAR& infobar = *GetInfoBar();
    infobar.RemoveAllButtons();
 
    wxArrayString msgs;
    int           infobarFlags = wxICON_INFORMATION;
 
    if( IsSymbolFromSchematic() )
    {
        msgs.push_back( wxString::Format( _( "Editing symbol %s from schematic.  Saving will "
                                             "update the schematic only." ),
                                          m_reference ) );
 
        wxString         link = wxString::Format( _( "Open symbol from library %s" ), libName );
        wxHyperlinkCtrl* button = new wxHyperlinkCtrl( &infobar, wxID_ANY, link, wxEmptyString );
 
        button->Bind( wxEVT_COMMAND_HYPERLINK, std::function<void( wxHyperlinkEvent& aEvent )>(
                [this, symbolName, libName]( wxHyperlinkEvent& aEvent )
                {
                    GetToolManager()->RunAction( SCH_ACTIONS::editLibSymbolWithLibEdit );
                } ) );
 
        infobar.AddButton( button );
    }
    else if( IsSymbolFromLegacyLibrary() )
    {
        msgs.push_back( _( "Symbols in legacy libraries are not editable.  Use Manage Symbol "
                           "Libraries to migrate to current format." ) );
 
        wxString         link = _( "Manage symbol libraries" );
        wxHyperlinkCtrl* button = new wxHyperlinkCtrl( &infobar, wxID_ANY, link, wxEmptyString );
 
        button->Bind( wxEVT_COMMAND_HYPERLINK, std::function<void( wxHyperlinkEvent& aEvent )>(
                [this]( wxHyperlinkEvent& aEvent )
                {
                    InvokeSchEditSymbolLibTable( &Kiway(), this );
                } ) );
 
        infobar.AddButton( button );
    }
    else if( IsSymbolAlias() )
    {
        msgs.push_back( wxString::Format( _( "Symbol %s is a derived symbol. Symbol graphics will "
                                             "not be editable." ),
                                          UnescapeString( symbolName ) ) );
 
        // Don't assume the parent symbol shared pointer is still valid.
        if( std::shared_ptr<LIB_SYMBOL> rootSymbol = m_symbol->GetRootSymbol() )
        {
            int      unit = GetUnit();
            int      bodyStyle = GetBodyStyle();
            wxString rootSymbolName = rootSymbol->GetName();
            wxString link = wxString::Format( _( "Open %s" ), UnescapeString( rootSymbolName ) );
 
            wxHyperlinkCtrl* button = new wxHyperlinkCtrl( &infobar, wxID_ANY, link,
                                                           wxEmptyString );
 
            button->Bind( wxEVT_COMMAND_HYPERLINK, std::function<void( wxHyperlinkEvent& aEvent )>(
                    [this, rootSymbolName, unit, bodyStyle]( wxHyperlinkEvent& aEvent )
                    {
                        LoadSymbolFromCurrentLib( rootSymbolName, unit, bodyStyle );
                    } ) );
 
            infobar.AddButton( button );
        }
    }
 
    if( m_symbol
            && !IsSymbolFromSchematic()
            && m_libMgr->IsLibraryReadOnly( m_symbol->GetLibId().GetFullLibraryName() ) )
    {
        msgs.push_back( _( "Library is read-only.  Changes cannot be saved to this library." ) );
 
        wxString         link = wxString::Format( _( "Create an editable copy" ) );
        wxHyperlinkCtrl* button = new wxHyperlinkCtrl( &infobar, wxID_ANY, link, wxEmptyString );
 
        button->Bind( wxEVT_COMMAND_HYPERLINK, std::function<void( wxHyperlinkEvent& aEvent )>(
                [this, symbolName, libName]( wxHyperlinkEvent& aEvent )
                {
                    wxString msg = wxString::Format( _( "Create an editable copy of the symbol or "
                                                        "the entire library (%s)?" ),
                                                     libName );
 
                    KIDIALOG errorDlg( this, msg, _( "Select type of item to save" ),
                                       wxYES_NO | wxCANCEL | wxICON_QUESTION );
                    // These buttons are in a weird order(?)
                    errorDlg.SetYesNoCancelLabels( _( "Copy symbol" ), _( "Cancel" ),
                                                   _( "Copy library" ) );
 
                    int choice = errorDlg.ShowModal();
 
                    switch( choice )
                    {
                    case wxID_YES:
                        SaveSymbolCopyAs( true );
                        break;
                    case wxID_CANCEL:
                        SaveLibraryAs();
                        break;
                    default:
                        // Do nothing
                        break;
                    }
                } ) );
 
        infobar.AddButton( button );
    }
 
    if( msgs.empty() )
    {
        infobar.Dismiss();
    }
    else
    {
        wxString msg = wxJoin( msgs, '\n', '\0' );
        infobar.ShowMessage( msg, infobarFlags );
    }
}
 
 
LIB_SYMBOL_LIBRARY_MANAGER& SYMBOL_EDIT_FRAME::GetLibManager()
{
    wxASSERT( m_libMgr );
    return *m_libMgr;
}
 
 
void SYMBOL_EDIT_FRAME::OnModify()
{
    EDA_BASE_FRAME::OnModify();
 
    GetScreen()->SetContentModified();
 
    if( !IsSymbolFromSchematic() )
        storeCurrentSymbol();
 
    if( m_isClosing )
        return;
 
    // Clear preview so a later library-open gets its own tab instead of replacing this edited one.
    if( m_tabsPanel && m_activeTab )
    {
        m_activeTab->SetPreview( false );
 
        if( int idx = m_tabsPanel->FindTab( m_activeTab->GetTabKey() ); idx >= 0 )
            m_tabsPanel->MarkModified( idx, true );
    }
 
    GetLibTree()->RefreshLibTree();
 
    if( !GetTitle().StartsWith( "*" ) )
        UpdateTitle();
}
 
 
void SYMBOL_EDIT_FRAME::SetUnit( int aUnit )
{
    wxCHECK( aUnit > 0 && aUnit <= GetCurSymbol()->GetUnitCount(), /* void*/ );
 
    if( m_unit == aUnit )
        return;
 
    m_toolManager->RunAction( ACTIONS::cancelInteractive );
    m_toolManager->RunAction( ACTIONS::selectionClear );
 
    m_unit = aUnit;
 
    if( m_unitSelectBox->GetSelection() != ( m_unit - 1 ) )
        m_unitSelectBox->SetSelection( m_unit - 1 );
 
    m_toolManager->ResetTools( TOOL_BASE::MODEL_RELOAD );
    RebuildView();
    UpdateSymbolMsgPanelInfo();
}
 
 
void SYMBOL_EDIT_FRAME::SetBodyStyle( int aBodyStyle )
{
    wxCHECK( aBodyStyle > 0 && aBodyStyle <= GetCurSymbol()->GetBodyStyleCount(), /* void */ );
 
    if( m_bodyStyle == aBodyStyle )
        return;
 
    m_toolManager->RunAction( ACTIONS::cancelInteractive );
    m_toolManager->RunAction( ACTIONS::selectionClear );
 
    m_bodyStyle = aBodyStyle;
 
    if( m_bodyStyleSelectBox->GetSelection() != ( m_bodyStyle - 1 ) )
        m_bodyStyleSelectBox->SetSelection( m_bodyStyle - 1 );
 
 
    m_toolManager->ResetTools( TOOL_BASE::MODEL_RELOAD );
    RebuildView();
    UpdateSymbolMsgPanelInfo();
}
 
 
bool SYMBOL_EDIT_FRAME::SynchronizePins()
{
    return m_SyncPinEdit && m_symbol && m_symbol->IsMultiUnit() && !m_symbol->UnitsLocked();
}
 
 
wxString SYMBOL_EDIT_FRAME::AddLibraryFile( bool aCreateNew )
{
    wxFileName               fn = m_libMgr->GetUniqueLibraryName();
    bool                     useGlobalTable = true;
    FILEDLG_HOOK_NEW_LIBRARY tableChooser( useGlobalTable );
 
    if( !LibraryFileBrowser( aCreateNew ? _( "New Symbol Library" ) : _( "Add Symbol Library" ),
                             !aCreateNew, fn, FILEEXT::KiCadSymbolLibFileWildcard(),
                             FILEEXT::KiCadSymbolLibFileExtension, false,
                             Pgm().GetSettingsManager().IsProjectOpenNotDummy() ? &tableChooser : nullptr ) )
    {
        return wxEmptyString;
    }
 
    LIBRARY_TABLE_SCOPE scope = tableChooser.GetUseGlobalTable() ? LIBRARY_TABLE_SCOPE::GLOBAL
                                                                 : LIBRARY_TABLE_SCOPE::PROJECT;
 
    LIBRARY_MANAGER&              manager = Pgm().GetLibraryManager();
    std::optional<LIBRARY_TABLE*> optTable = manager.Table( LIBRARY_TABLE_TYPE::SYMBOL, scope );
 
    wxCHECK( optTable.has_value(), wxEmptyString );
    LIBRARY_TABLE* table = optTable.value();
 
    wxString libName = fn.GetName();
 
    if( libName.IsEmpty() )
        return wxEmptyString;
 
    SYMBOL_LIBRARY_ADAPTER* adapter = PROJECT_SCH::SymbolLibAdapter( &Prj() );
 
    if( adapter->HasLibrary( libName ) )
    {
        DisplayError( this, wxString::Format( _( "Library '%s' already exists." ), libName ) );
        return wxEmptyString;
    }
 
    if( aCreateNew )
    {
        // The file browser already asked to overwrite, so drop the old file here.
        // CreateLibrary fails on an existing path.
        if( fn.FileExists() && !wxRemoveFile( fn.GetFullPath() ) )
        {
            DisplayError( this, wxString::Format( _( "Could not overwrite the library file '%s'.\n"
                                                     "Make sure you have write permissions and try again." ),
                                                  fn.GetFullPath() ) );
            return wxEmptyString;
        }
 
        if( !m_libMgr->CreateLibrary( fn.GetFullPath(), scope ) )
        {
            DisplayError( this, wxString::Format( _( "Could not create the library file '%s'.\n"
                                                     "Make sure you have write permissions and try again." ),
                                                  fn.GetFullPath() ) );
            return wxEmptyString;
        }
    }
    else
    {
        if( !m_libMgr->AddLibrary( fn.GetFullPath(), scope ) )
        {
            DisplayError( this, _( "Could not open the library file." ) );
            return wxEmptyString;
        }
    }
 
    bool success = true;
 
    // Tables are reinitialized by m_libMgr->AddLibrary(). So reinit table reference.
    optTable = manager.Table( LIBRARY_TABLE_TYPE::SYMBOL, scope );
    wxCHECK( optTable.has_value(), wxEmptyString );
    table = optTable.value();
 
    table->Save().map_error(
            [&]( const LIBRARY_ERROR& aError )
            {
                KICAD_MESSAGE_DIALOG dlg( this, _( "Error saving library table." ), _( "File Save Error" ),
                                          wxOK | wxICON_ERROR );
                dlg.SetExtendedMessage( aError.message );
                dlg.ShowModal();
 
                success = false;
            } );
 
    if( success )
        adapter->LoadOne( fn.GetName() );
 
    SyncLibraries( false );
    SetCurLib( fn.GetName() );
 
    if( m_treePane )
    {
        LIB_ID libId( fn.GetName(), wxEmptyString );
        GetLibTree()->SelectLibId( libId );
        GetLibTree()->CenterLibId( libId );
    }
 
    return fn.GetFullPath();
}
 
 
void SYMBOL_EDIT_FRAME::DdAddLibrary( wxString aLibFile )
{
    wxFileName fn = wxFileName( aLibFile );
    wxString   libName = fn.GetName();
 
    if( libName.IsEmpty() )
        return;
 
    LIBRARY_MANAGER&        manager = Pgm().GetLibraryManager();
    SYMBOL_LIBRARY_ADAPTER* adapter = PROJECT_SCH::SymbolLibAdapter( &Prj() );
 
    if( adapter->HasLibrary( libName ) )
    {
        DisplayError( this, wxString::Format( _( "Library '%s' already exists." ), libName ) );
        return;
    }
 
    if( !m_libMgr->AddLibrary( fn.GetFullPath(), LIBRARY_TABLE_SCOPE::PROJECT ) )
    {
        DisplayError( this, _( "Could not open the library file." ) );
        return;
    }
 
    std::optional<LIBRARY_TABLE*> optTable = manager.Table( LIBRARY_TABLE_TYPE::SYMBOL, LIBRARY_TABLE_SCOPE::PROJECT );
    wxCHECK( optTable.has_value(), /* void */ );
    LIBRARY_TABLE* table = optTable.value();
    bool           success = true;
 
    table->Save().map_error(
            [&]( const LIBRARY_ERROR& aError )
            {
                KICAD_MESSAGE_DIALOG dlg( this, _( "Error saving library table." ), _( "File Save Error" ),
                                          wxOK | wxICON_ERROR );
                dlg.SetExtendedMessage( aError.message );
                dlg.ShowModal();
 
                success = false;
            } );
 
    if( success )
        adapter->LoadOne( libName );
 
    std::string packet = fn.GetFullPath().ToStdString();
    this->Kiway().ExpressMail( FRAME_SCH_SYMBOL_EDITOR, MAIL_RELOAD_LIB, packet );
    this->Kiway().ExpressMail( FRAME_SCH_SYMBOL_EDITOR, MAIL_LIB_EDIT, packet );
}
 
 
LIB_ID SYMBOL_EDIT_FRAME::GetTreeLIBID( int* aUnit ) const
{
    return GetLibTree()->GetSelectedLibId( aUnit );
}
 
 
int SYMBOL_EDIT_FRAME::GetTreeSelectionCount() const
{
    return GetLibTree()->GetSelectionCount();
}
 
int SYMBOL_EDIT_FRAME::GetTreeLIBIDs( std::vector<LIB_ID>& aSelection ) const
{
    return GetLibTree()->GetSelectedLibIds( aSelection );
}
 
 
LIB_SYMBOL* SYMBOL_EDIT_FRAME::getTargetSymbol() const
{
    if( IsLibraryTreeShown() )
    {
        LIB_ID libId = GetTreeLIBID();
 
        if( libId.IsValid() )
            return m_libMgr->GetSymbol( libId.GetLibItemName(), libId.GetLibNickname() );
    }
 
    return m_symbol;
}
 
 
LIB_ID SYMBOL_EDIT_FRAME::GetTargetLibId() const
{
    LIB_ID id;
 
    if( IsLibraryTreeShown() )
        id = GetTreeLIBID();
 
    if( id.GetLibNickname().empty() && m_symbol )
        id = m_symbol->GetLibId();
 
    return id;
}
 
 
std::vector<LIB_ID> SYMBOL_EDIT_FRAME::GetSelectedLibIds() const
{
    std::vector<LIB_ID> ids;
    GetTreeLIBIDs( ids );
    return ids;
}
 
 
wxString SYMBOL_EDIT_FRAME::getTargetLib() const
{
    return GetTargetLibId().GetLibNickname();
}
 
 
void SYMBOL_EDIT_FRAME::SyncLibraries( bool aShowProgress, bool aPreloadCancelled,
                                       const wxString& aForceRefresh )
{
    wxLogTrace( wxT( "KICAD_TABS_DBG" ),
                wxT( "SYMBOL_EDIT_FRAME::SyncLibraries enter (progress=%d, forceRefresh='%s')" ),
                aShowProgress, aForceRefresh );
 
    // Prevent re-entrant calls.  The progress dialog yields the event loop during Sync(),
    // which can dispatch queued UI events (e.g. menu clicks queued while the app was busy
    // loading libraries).  A re-entrant call would corrupt the library tree mid-rebuild.
    if( m_syncLibrariesInProgress )
    {
        wxLogTrace( wxT( "KICAD_TABS_DBG" ),
                    wxT( "SYMBOL_EDIT_FRAME::SyncLibraries re-entrant; skipping" ) );
        return;
    }
 
    m_syncLibrariesInProgress = true;
 
    auto resetGuard = [this]( bool* )
    {
        m_syncLibrariesInProgress = false;
    };
 
    std::unique_ptr<bool, decltype( resetGuard )> guard( &m_syncLibrariesInProgress, resetGuard );
 
    LIB_ID              selected;
    std::vector<LIB_ID> expanded;
 
    if( m_treePane )
    {
        selected = GetLibTree()->GetSelectedLibId();
        expanded = GetLibTree()->GetExpandedLibraries();
    }
 
    // Ensure any in-progress background library preloading is complete before syncing the
    // tree. Without this, libraries still in LOADING state get skipped by Sync(), resulting
    // in an incomplete tree that requires a manual refresh to fully populate.
    SYMBOL_LIBRARY_ADAPTER* adapter = PROJECT_SCH::SymbolLibAdapter( &Prj() );
    adapter->BlockUntilLoaded();
 
    if( aShowProgress )
    {
        APP_PROGRESS_DIALOG progressDlg( _( "Loading Symbol Libraries" ), wxEmptyString,
                                         m_libMgr->GetAdapter()->GetLibrariesCount(), this );
 
        THROTTLE  progressThrottle( std::chrono::milliseconds( 350 ) );
        int       pendingProgress = 0;
        bool      callbackFired = false;
        wxString  pendingLibName;
 
        m_libMgr->Sync( aForceRefresh,
                [&]( int progress, int max, const wxString& libName )
                {
                    pendingProgress = progress;
                    pendingLibName = libName;
                    callbackFired = true;
 
                    if( progressThrottle.Ready() )
                        progressDlg.Update( progress, wxString::Format( _( "Loading library '%s'..." ), libName ) );
                } );
 
        if( callbackFired )
            progressDlg.Update( pendingProgress, wxString::Format( _( "Loading library '%s'..." ), pendingLibName ) );
    }
    else if( !aPreloadCancelled )
    {
        m_libMgr->Sync( aForceRefresh, [&]( int progress, int max, const wxString& libName ) {} );
    }
 
    if( m_treePane )
    {
        wxDataViewItem found;
 
        if( selected.IsValid() )
        {
            // Check if the previously selected item is still valid,
            // if not - it has to be unselected to prevent crash
            found = m_libMgr->GetAdapter()->FindItem( selected );
 
            if( !found )
                GetLibTree()->Unselect();
        }
 
        wxLogTrace( wxT( "KICAD_TABS_DBG" ), wxT( "SYMBOL_EDIT_FRAME::SyncLibraries Regenerate" ) );
        GetLibTree()->Regenerate( true );
 
        // Sync() collapsed the tree, so re-expand the libraries that were open before it.
        for( const LIB_ID& libId : expanded )
            GetLibTree()->ExpandLibId( libId );
 
        // Try to select the parent library, in case the symbol is not found
        if( !found && selected.IsValid() )
        {
            selected.SetLibItemName( "" );
            found = m_libMgr->GetAdapter()->FindItem( selected );
 
            if( found )
                GetLibTree()->SelectLibId( selected );
        }
 
        // If no selection, see if there's a current symbol to centre
        if( !selected.IsValid() && m_symbol )
        {
            LIB_ID current( GetCurLib(), m_symbol->GetName() );
            GetLibTree()->CenterLibId( current );
        }
    }
 
    wxLogTrace( wxT( "KICAD_TABS_DBG" ), wxT( "SYMBOL_EDIT_FRAME::SyncLibraries exit" ) );
}
 
 
void SYMBOL_EDIT_FRAME::RefreshLibraryTree()
{
    GetLibTree()->RefreshLibTree();
}
 
 
void SYMBOL_EDIT_FRAME::FocusOnLibId( const LIB_ID& aLibID )
{
    GetLibTree()->SelectLibId( aLibID );
}
 
 
void SYMBOL_EDIT_FRAME::UpdateLibraryTree( const wxDataViewItem& aTreeItem, LIB_SYMBOL* aSymbol )
{
    if( aTreeItem.IsOk() )   // Can be not found in tree if the current footprint is imported
                             // from file therefore not yet in tree.
    {
        static_cast<LIB_TREE_NODE_ITEM*>( aTreeItem.GetID() )->Update( aSymbol );
        GetLibTree()->RefreshLibTree();
    }
}
 
 
bool SYMBOL_EDIT_FRAME::backupFile( const wxFileName& aOriginalFile, const wxString& aBackupExt )
{
    if( aOriginalFile.FileExists() )
    {
        wxFileName backupFileName( aOriginalFile );
        backupFileName.SetExt( aBackupExt );
 
        if( backupFileName.FileExists() )
            wxRemoveFile( backupFileName.GetFullPath() );
 
        if( !wxCopyFile( aOriginalFile.GetFullPath(), backupFileName.GetFullPath() ) )
        {
            DisplayError( this, wxString::Format( _( "Failed to save backup to '%s'." ),
                                                  backupFileName.GetFullPath() ) );
            return false;
        }
    }
 
    return true;
}
 
 
void SYMBOL_EDIT_FRAME::storeCurrentSymbol()
{
    if( m_symbol && !GetCurLib().IsEmpty() && GetScreen()->IsContentModified() )
        m_libMgr->UpdateSymbol( m_symbol, GetCurLib() ); // UpdateSymbol() makes a copy
}
 
 
bool SYMBOL_EDIT_FRAME::IsCurrentSymbol( const LIB_ID& aLibId ) const
{
    // This will return the root symbol of any alias
    LIB_SYMBOL* symbol = m_libMgr->GetBufferedSymbol( aLibId.GetLibItemName(), aLibId.GetLibNickname() );
 
    // Now we can compare the libId of the current symbol and the root symbol
    return ( symbol && m_symbol && symbol->GetLibId() == m_symbol->GetLibId() );
}
 
 
void SYMBOL_EDIT_FRAME::emptyScreen()
{
    GetLibTree()->Unselect();
    SetCurLib( wxEmptyString );
 
    // Tear down every tab first so no context observes the about-to-be-deleted working symbol.
    closeAllSymbolTabsSilently();
 
    SetCurSymbol( nullptr, false );
    SetScreen( m_dummyScreen );
    ClearUndoRedoList();
    m_toolManager->RunAction( ACTIONS::zoomFitScreen );
    Refresh();
}
 
 
void SYMBOL_EDIT_FRAME::CommonSettingsChanged( int aFlags )
{
    SCH_BASE_FRAME::CommonSettingsChanged( aFlags );
 
    if( SYMBOL_EDITOR_SETTINGS* cfg = GetAppSettings<SYMBOL_EDITOR_SETTINGS>( "symbol_editor" ) )
    {
        GetRenderSettings()->m_ShowPinsElectricalType = cfg->m_ShowPinElectricalType;
        GetRenderSettings()->m_ShowHiddenPins = cfg->m_ShowHiddenPins;
        GetRenderSettings()->m_ShowHiddenFields = cfg->m_ShowHiddenFields;
        GetRenderSettings()->m_ShowPinAltIcons = cfg->m_ShowPinAltIcons;
 
        GetGalDisplayOptions().ReadWindowSettings( cfg->m_Window );
    }
 
    if( m_symbol )
        m_symbol->ClearCaches();
 
    GetCanvas()->ForceRefresh();
 
    GetCanvas()->GetView()->UpdateAllItems( KIGFX::ALL );
    GetCanvas()->Refresh();
 
    RecreateToolbars();
 
    if( aFlags & ENVVARS_CHANGED )
        SyncLibraries( true );
 
    Layout();
    SendSizeEvent();
}
 
 
void SYMBOL_EDIT_FRAME::ShowChangedLanguage()
{
    // call my base class
    SCH_BASE_FRAME::ShowChangedLanguage();
 
    // tooltips in toolbars
    RecreateToolbars();
 
    // For some obscure reason, the AUI manager hides the first modified pane.
    // So force show panes
    wxAuiPaneInfo& tree_pane_info = m_auimgr.GetPane( m_treePane );
    bool tree_shown = tree_pane_info.IsShown();
    tree_pane_info.Caption( _( "Libraries" ) );
    tree_pane_info.Show( tree_shown );
    m_auimgr.Update();
 
    GetLibTree()->ShowChangedLanguage();
 
    // status bar
    UpdateMsgPanel();
 
    if( GetRenderSettings()->m_ShowPinsElectricalType )
    {
        GetCanvas()->GetView()->UpdateAllItems( KIGFX::ALL );
        GetCanvas()->Refresh();
    }
 
    UpdateTitle();
}
 
 
void SYMBOL_EDIT_FRAME::SetScreen( BASE_SCREEN* aScreen )
{
    SCH_BASE_FRAME::SetScreen( aScreen );
 
    if( m_toolManager )
    {
        m_toolManager->SetEnvironment( aScreen, GetCanvas()->GetView(), GetCanvas()->GetViewControls(), GetSettings(),
                                       this );
        m_toolManager->ResetTools( TOOL_BASE::MODEL_RELOAD );
    }
}
 
 
void SYMBOL_EDIT_FRAME::RebuildView()
{
    GetRenderSettings()->m_ShowUnit = m_unit;
    GetRenderSettings()->m_ShowBodyStyle = m_bodyStyle;
    GetRenderSettings()->m_ShowDisabled = IsSymbolFromLegacyLibrary() && !IsSymbolFromSchematic();
    GetRenderSettings()->m_ShowGraphicsDisabled = IsSymbolAlias() && !IsSymbolFromSchematic();
    GetCanvas()->DisplaySymbol( m_symbol );
    GetCanvas()->GetView()->HideDrawingSheet();
    GetCanvas()->GetView()->ClearHiddenFlags();
 
    // Let tools add things to the view if necessary
    if( m_toolManager )
        m_toolManager->ResetTools( TOOL_BASE::MODEL_RELOAD );
 
    GetCanvas()->GetView()->UpdateAllItems( KIGFX::ALL );
    GetCanvas()->Refresh();
}
 
 
void SYMBOL_EDIT_FRAME::HardRedraw()
{
    SyncLibraries( true );
 
    if( m_symbol )
    {
        SCH_SELECTION_TOOL* selectionTool = m_toolManager->GetTool<SCH_SELECTION_TOOL>();
        SCH_SELECTION&      selection = selectionTool->GetSelection();
 
        for( SCH_ITEM& item : m_symbol->GetDrawItems() )
        {
            if( !alg::contains( selection, &item ) )
                item.ClearSelected();
            else
                item.SetSelected();
        }
 
        m_symbol->ClearCaches();
    }
 
    RebuildView();
}
 
 
const BOX2I SYMBOL_EDIT_FRAME::GetDocumentExtents( bool aIncludeAllVisible ) const
{
    if( !m_symbol )
    {
        // Gives a reasonable drawing area size
        int width = schIUScale.mmToIU( 50 );
        int height = schIUScale.mmToIU( 30 );
 
        return BOX2I( VECTOR2I( -width/2, -height/2 ), VECTOR2I( width, height ) );
    }
    else
    {
        return m_symbol->Flatten()->GetUnitBoundingBox( m_unit, m_bodyStyle );
    }
}
 
 
void SYMBOL_EDIT_FRAME::FocusOnItem( EDA_ITEM* aItem, bool aAllowScroll )
{
    static KIID lastBrightenedItemID( niluuid );
 
    SCH_ITEM* lastItem = nullptr;
 
    // nullptr will clear the current focus
    if( aItem != nullptr && !aItem->IsSCH_ITEM() )
        return;
 
    if( m_symbol )
    {
        for( SCH_PIN* pin : m_symbol->GetGraphicalPins( 0, 0 ) )
        {
            if( pin->m_Uuid == lastBrightenedItemID )
                lastItem = pin;
        }
 
        std::vector<SCH_FIELD*> fields;
        m_symbol->GetFields( fields );
 
        for( SCH_FIELD* field : fields )
        {
            if( field->m_Uuid == lastBrightenedItemID )
                lastItem = field;
        }
    }
 
    if( lastItem && lastItem != aItem )
    {
        lastItem->ClearBrightened();
 
        UpdateItem( lastItem );
        lastBrightenedItemID = niluuid;
    }
 
    if( aItem )
    {
        if( aItem->IsSCH_ITEM() )
        {
            SCH_ITEM* item = static_cast<SCH_ITEM*>( aItem );
 
            if( int unit = item->GetUnit() )
                SetUnit( unit );
 
            if( int bodyStyle = item->GetBodyStyle() )
                SetBodyStyle( bodyStyle );
        }
 
        if( !aItem->IsBrightened() )
        {
            aItem->SetBrightened();
 
            UpdateItem( aItem );
            lastBrightenedItemID = aItem->m_Uuid;
        }
 
        FocusOnLocation( VECTOR2I( aItem->GetFocusPosition().x, aItem->GetFocusPosition().y ), aAllowScroll );
    }
}
 
 
void SYMBOL_EDIT_FRAME::KiwayMailIn( KIWAY_MAIL_EVENT& mail )
{
    const std::string& payload = mail.GetPayload();
 
    wxLogTrace( wxT( "KICAD_TABS_DBG" ), wxT( "SYMBOL_EDIT_FRAME::KiwayMailIn cmd=%d" ),
                (int) mail.Command() );
 
    switch( mail.Command() )
    {
    case MAIL_LIB_EDIT:
        if( !payload.empty() )
        {
            wxString uri( payload );
            wxString libNickname;
            wxString msg;
 
            SYMBOL_LIBRARY_ADAPTER* adapter = PROJECT_SCH::SymbolLibAdapter( &Prj() );
            std::optional<const LIBRARY_TABLE_ROW*> libTableRow = adapter->FindRowByURI( uri );
 
            if( !libTableRow )
            {
                msg.Printf( _( "The current configuration does not include the symbol library '%s'." ),
                            uri );
                msg += wxS( "\n" ) + _( "Use Manage Symbol Libraries to edit the configuration." );
                DisplayErrorMessage( this, _( "Library not found in symbol library table." ), msg );
                break;
            }
 
            libNickname = ( *libTableRow )->Nickname();
 
            if( !adapter->HasLibrary( libNickname, true ) )
            {
                msg.Printf( _( "The symbol library '%s' is not enabled in the current configuration." ),
                            UnescapeString( libNickname ) );
                msg += wxS( "\n" ) + _( "Use Manage Symbol Libraries to edit the configuration." );
                DisplayErrorMessage( this, _( "Symbol library not enabled." ), msg );
                break;
            }
 
            SetCurLib( libNickname );
 
            if( m_treePane )
            {
                LIB_ID id( libNickname, wxEmptyString );
                GetLibTree()->SelectLibId( id );
                GetLibTree()->ExpandLibId( id );
                GetLibTree()->CenterLibId( id );
            }
        }
 
        break;
 
    case MAIL_RELOAD_LIB:
    {
        wxLogTrace( wxT( "KICAD_TABS_DBG" ),
                    wxT( "SYMBOL_EDIT_FRAME::KiwayMailIn MAIL_RELOAD_LIB -> SyncLibraries" ) );
 
        wxString          currentLib = GetCurLib();
 
        FreezeLibraryTree();
 
        // Check if the currently selected symbol library been removed or disabled.
        if( !currentLib.empty()
            && !PROJECT_SCH::SymbolLibAdapter( &Prj() )->HasLibrary( currentLib, true ) )
        {
            SetCurLib( wxEmptyString );
            emptyScreen();
        }
 
        // Suppress the progress dialog for this background reload. It would steal focus from the
        // editor that broadcast the reload, and the tree is already frozen around the sync.
        SyncLibraries( false );
        ThawLibraryTree();
        RefreshLibraryTree();
 
        break;
    }
 
    case MAIL_REFRESH_SYMBOL:
    {
        SYMBOL_LIBRARY_ADAPTER* adapter = PROJECT_SCH::SymbolLibAdapter( &Prj() );
        LIB_SYMBOL* symbol = GetCurSymbol();
 
        wxLogTrace( traceLibWatch, "Received refresh symbol request for %s", payload );
 
        if( !symbol )
            break;
 
        // Capture the name now. UpdateLibraryBuffer() recreates the buffer, so reading it from the
        // buffer copy afterwards would be a use-after-free.
        const wxString refreshSymbolName = symbol->GetName();
 
        // If the frame is disabled then a modal/quasi-modal dialog (such as the symbol properties dialog) is
        // editing the current LIB_SYMBOL.  Refreshing it here would delete the symbol out from under the dialog
        // and crash on dismissal.  The file watcher timer will retry the reload once the dialog has closed.
        if( !IsEnabled() )
        {
            wxLogTrace( traceLibWatch, "Deferring symbol refresh; dialog is open on the symbol editor." );
            break;
        }
        // Defensive backstop for refresh mail that did not originate from this frame's debounce
        // timer (which already defers while a tool is active).  An interactive tool holds
        // references into the current symbol, so replacing it here would crash; drop this refresh
        // and let the originating watcher retry.
        else if( !ToolStackIsEmpty() )
        {
            wxLogTrace( traceLibWatch, "Deferring symbol refresh; an interactive tool is active." );
            break;
        }
 
        wxString libName = symbol->GetLibId().GetLibNickname();
        std::optional<const LIBRARY_TABLE_ROW*> row = adapter->GetRow( libName );
 
        if( !row )
            return;
 
        wxFileName libfullname( LIBRARY_MANAGER::GetFullURI( *row, true ) );
 
        wxFileName changedLib( mail.GetPayload() );
 
        wxLogTrace( traceLibWatch, "Received refresh symbol request for %s, current symbols is %s",
                    changedLib.GetFullPath(), libfullname.GetFullPath() );
 
        if( changedLib == libfullname )
        {
            wxLogTrace( traceLibWatch, "Refreshing symbol %s", refreshSymbolName );
 
            m_libMgr->UpdateLibraryBuffer( libName );
 
            if( LIB_SYMBOL* lib_symbol = m_libMgr->GetBufferedSymbol( refreshSymbolName, libName ) )
            {
                SetCurSymbol( new LIB_SYMBOL( *lib_symbol ), false );
                RebuildSymbolUnitAndBodyStyleLists();
 
                if( m_toolManager )
                    m_toolManager->ResetTools( TOOL_BASE::MODEL_RELOAD );
            }
        }
 
        break;
    }
 
    default:
        break;
    }
}
 
 
std::unique_ptr<GRID_HELPER> SYMBOL_EDIT_FRAME::MakeGridHelper()
{
    return std::make_unique<EE_GRID_HELPER>( m_toolManager );
}
 
 
void SYMBOL_EDIT_FRAME::SwitchCanvas( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType )
{
    // switches currently used canvas ( Cairo / OpenGL):
    SCH_BASE_FRAME::SwitchCanvas( aCanvasType );
 
    // Set options specific to symbol editor (axies are always enabled):
    GetCanvas()->GetGAL()->SetAxesEnabled( true );
    GetCanvas()->GetGAL()->SetAxesColor( m_colorSettings->GetColor( LAYER_SCHEMATIC_GRID_AXES ) );
}
 
 
bool SYMBOL_EDIT_FRAME::HasLibModifications() const
{
    wxCHECK( m_libMgr, false );
 
    return m_libMgr->HasModifications();
}
 
 
bool SYMBOL_EDIT_FRAME::IsContentModified() const
{
    wxCHECK( m_libMgr, false );
 
    // Test if the currently edited symbol is modified
    if( GetScreen() && GetScreen()->IsContentModified() && GetCurSymbol() )
        return true;
 
    // Test if any library has been modified
    for( const wxString& libName : m_libMgr->GetLibraryNames() )
    {
        if( m_libMgr->IsLibraryModified( libName ) && !m_libMgr->IsLibraryReadOnly( libName ) )
            return true;
    }
 
    return false;
}
 
 
void SYMBOL_EDIT_FRAME::ClearUndoORRedoList( UNDO_REDO_LIST whichList, int aItemCount )
{
    if( aItemCount == 0 )
        return;
 
    UNDO_REDO_CONTAINER& list = ( whichList == UNDO_LIST ) ? m_undoList : m_redoList;
 
    // UR_TRANSIENT is flagged on the picked item, not the wrapper, so the shared deleters miss it.
    // Free the items carrying UR_TRANSIENT. m_symbol never carries it, so the live copy is safe.
    if( aItemCount < 0 )
    {
        freeTransientUndoCommands( list, m_symbol );
    }
    else
    {
        for( int ii = 0; ii < aItemCount; ii++ )
        {
            if( list.m_CommandsList.size() == 0 )
                break;
 
            PICKED_ITEMS_LIST* curr_cmd = list.m_CommandsList[0];
            list.m_CommandsList.erase( list.m_CommandsList.begin() );
 
            for( unsigned jj = 0; jj < curr_cmd->GetCount(); ++jj )
            {
                EDA_ITEM* item = curr_cmd->GetPickedItem( jj );
 
                if( item && item->HasFlag( UR_TRANSIENT ) && item != m_symbol )
                    delete item;
            }
 
            curr_cmd->ClearItemsList();
            delete curr_cmd;    // Delete command
        }
    }
}
 
 
SELECTION& SYMBOL_EDIT_FRAME::GetCurrentSelection()
{
    return m_toolManager->GetTool<SCH_SELECTION_TOOL>()->GetSelection();
}
 
 
bool SYMBOL_EDIT_FRAME::libTreeAutoHiddenForSchematicEdit( bool aWasFromSchematic,
                                                           bool aRestorePending, bool aTreeShownNow )
{
    // Auto-hiding a visible tree schedules its restore. A chained schematic edit finds the tree
    // already auto-hidden, so keep the pending restore rather than dropping it. An explicit user
    // toggle clears the flag elsewhere, so a tree hidden without a pending restore stays that way.
    if( aTreeShownNow )
        return true;
 
    return aWasFromSchematic && aRestorePending;
}
 
 
void SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic( SCH_SYMBOL* aSymbol )
{
    std::unique_ptr<LIB_SYMBOL> symbol = aSymbol->GetLibSymbolRef()->Flatten();
    wxCHECK( symbol, /* void */ );
 
    symbol->SetLibId( aSymbol->GetLibId() );
 
    // Take in account the symbol orientation and mirroring. to calculate the field
    // positions in symbol editor (i.e. no rotation, no mirroring)
    int orientation = aSymbol->GetOrientation() & ~( SYM_MIRROR_X | SYM_MIRROR_Y );
    int mirror = aSymbol->GetOrientation() & ( SYM_MIRROR_X | SYM_MIRROR_Y );
 
    std::vector<SCH_FIELD> fullSetOfFields;
 
    for( const SCH_FIELD& field : aSymbol->GetFields() )
    {
        VECTOR2I  pos = field.GetPosition() - aSymbol->GetPosition();
        SCH_FIELD libField( symbol.get(), field.GetId() );
 
        libField = field;
 
        // The inverse transform is mirroring before, rotate after
        switch( mirror )
        {
        case SYM_MIRROR_X: pos.y = -pos.y; break;
        case SYM_MIRROR_Y: pos.x = -pos.x; break;
        default:                           break;
        }
 
        switch( orientation )
        {
        case SYM_ORIENT_90:
            std::swap( pos.x, pos.y );
            pos.x = - pos.x;
            break;
        case SYM_ORIENT_270:
            std::swap( pos.x, pos.y );
            pos.y = - pos.y;
            break;
        case SYM_ORIENT_180:
            pos.x = - pos.x;
            pos.y = - pos.y;
            break;
        default:
            break;
        }
 
        libField.SetPosition( pos );
 
        fullSetOfFields.emplace_back( std::move( libField ) );
    }
 
    symbol->SetFields( fullSetOfFields );
 
    const wxString reference = symbol->GetReferenceField().GetText();
    const int      unit = std::max( 1, aSymbol->GetUnit() );
    const int      bodyStyle = std::max( 1, aSymbol->GetBodyStyle() );
 
    // Optimize default edit options for this symbol
    // Usually if units are locked, graphic items are specific to each unit
    // and if units are interchangeable, graphic items are common to units
    SYMBOL_EDITOR_DRAWING_TOOLS* tools = GetToolManager()->GetTool<SYMBOL_EDITOR_DRAWING_TOOLS>();
    tools->SetDrawSpecificUnit( symbol->UnitsLocked() );
 
    // Hand the transient working symbol/screen to a session-only instance tab, whose activation
    // restores the frame's schematic-source state so the save path routes back to the schematic.
    SCH_SCREEN* tmpScreen = new SCH_SCREEN();
 
    setSymWatcher( nullptr );
 
    SYMBOL_EDITOR_TAB_CONTEXT* ctx = findOrCreateSymbolInstanceTab( symbol.release(), tmpScreen,
                                                                    aSymbol->m_Uuid, reference, unit,
                                                                    bodyStyle );
    wxCHECK( ctx, /* void */ );
 
    ReCreateMenuBar();
    RecreateToolbars();
 
    // Auto-hide the tree while editing a schematic symbol, remembering to restore it in SaveSettings
    // so the user's preference survives a restart. Hide via the pane directly, not ToggleLibraryTree,
    // which would treat this as a user toggle and drop the pending restore.
    m_libTreeAutoHiddenForSchematicEdit = libTreeAutoHiddenForSchematicEdit(
            m_isSymbolFromSchematic, m_libTreeAutoHiddenForSchematicEdit, IsLibraryTreeShown() );
 
    if( IsLibraryTreeShown() )
    {
        m_auimgr.GetPane( m_treePane ).Show( false );
        updateSelectionFilterVisbility();
        m_auimgr.Update();
        Refresh();
    }
 
    UpdateTitle();
    RebuildSymbolUnitAndBodyStyleLists();
    UpdateSymbolMsgPanelInfo();
 
    // Let tools add things to the view if necessary
    if( m_toolManager )
        m_toolManager->ResetTools( TOOL_BASE::MODEL_RELOAD );
 
    GetCanvas()->GetView()->UpdateAllItems( KIGFX::ALL );
    GetCanvas()->Refresh();
}
 
 
bool SYMBOL_EDIT_FRAME::addLibTableEntry( const wxString& aLibFile, LIBRARY_TABLE_SCOPE aScope )
{
    wxFileName fn = aLibFile;
    wxFileName libTableFileName( Prj().GetProjectPath(), FILEEXT::SymbolLibraryTableFileName );
    wxString libNickname = fn.GetName();
    SYMBOL_LIBRARY_ADAPTER* adapter = PROJECT_SCH::SymbolLibAdapter( &Prj() );
    LIBRARY_MANAGER&        manager = Pgm().GetLibraryManager();
    const ENV_VAR_MAP&      envVars = Pgm().GetLocalEnvVariables();
 
    if( adapter->HasLibrary( libNickname ) )
    {
        wxString tmp;
        int suffix = 1;
 
        while( adapter->HasLibrary( libNickname ) )
        {
            tmp.Printf( "%s%d", fn.GetName(), suffix );
            libNickname = tmp;
            suffix += 1;
        }
    }
 
    std::optional<LIBRARY_TABLE*> optTable = manager.Table( LIBRARY_TABLE_TYPE::SYMBOL, aScope );
    wxCHECK( optTable.has_value(), false );
    LIBRARY_TABLE* table = optTable.value();
 
    LIBRARY_TABLE_ROW* row = &table->InsertRow();
 
    row->SetNickname( libNickname );
 
    // We cannot normalize against the current project path when saving to global table.
    wxString normalizedPath = NormalizePath( aLibFile, &envVars,
                                             aScope == LIBRARY_TABLE_SCOPE::PROJECT ? Prj().GetProjectPath()
                                                                                    : wxString( wxEmptyString ) );
 
    row->SetURI( normalizedPath );
    row->SetType( SCH_IO_MGR::ShowType( SCH_IO_MGR::GuessPluginTypeFromLibPath( normalizedPath ) ) );
 
    bool success = true;
 
    table->Save().map_error(
            [&]( const LIBRARY_ERROR& aError )
            {
                KICAD_MESSAGE_DIALOG dlg( this, _( "Error saving library table." ), _( "File Save Error" ),
                                          wxOK | wxICON_ERROR );
                dlg.SetExtendedMessage( aError.message );
                dlg.ShowModal();
 
                success = false;
            } );
 
    if( success )
    {
        manager.ReloadTables( aScope, { LIBRARY_TABLE_TYPE::SYMBOL } );
        adapter->LoadOne( libNickname );
    }
 
    return success;
}
 
 
bool SYMBOL_EDIT_FRAME::replaceLibTableEntry( const wxString& aLibNickname, const wxString& aLibFile )
{
    SYMBOL_LIBRARY_ADAPTER* adapter = PROJECT_SCH::SymbolLibAdapter( &Prj() );
    LIBRARY_MANAGER&        manager = Pgm().GetLibraryManager();
    LIBRARY_TABLE*          table = nullptr;
    LIBRARY_TABLE_SCOPE     scope = LIBRARY_TABLE_SCOPE::GLOBAL;
 
    // Check the global library table first because checking the project library table
    // checks the global library table as well due to library chaining.
    if( adapter->GetRow( aLibNickname, scope ) )
    {
        std::optional<LIBRARY_TABLE*> optTable = manager.Table( LIBRARY_TABLE_TYPE::SYMBOL, scope );
        wxCHECK( optTable.has_value(), false );
        table = optTable.value();
    }
    else
    {
        scope = LIBRARY_TABLE_SCOPE::PROJECT;
 
        if( adapter->GetRow( aLibNickname, scope ) )
        {
            std::optional<LIBRARY_TABLE*> optTable = manager.Table( LIBRARY_TABLE_TYPE::SYMBOL, scope );
 
            if( optTable.has_value() )
                table = optTable.value();
        }
    }
 
    wxCHECK( table, false );
 
    std::optional<LIBRARY_TABLE_ROW*> optRow = adapter->GetRow( aLibNickname, scope );
    wxCHECK( optRow.has_value(), false );
    LIBRARY_TABLE_ROW* row = optRow.value();
 
    const ENV_VAR_MAP& envVars = Pgm().GetLocalEnvVariables();
 
    wxString projectPath;
 
    if( scope == LIBRARY_TABLE_SCOPE::PROJECT )
        projectPath = Prj().GetProjectPath();
 
    wxString normalizedPath = NormalizePath( aLibFile, &envVars, projectPath );
 
    row->SetURI( normalizedPath );
    row->SetType( "KiCad" );
 
    bool success = true;
 
    table->Save().map_error(
            [&]( const LIBRARY_ERROR& aError )
            {
                KICAD_MESSAGE_DIALOG dlg( this, _( "Error saving library table." ), _( "File Save Error" ),
                                          wxOK | wxICON_ERROR );
                dlg.SetExtendedMessage( aError.message );
                dlg.ShowModal();
 
                success = false;
            } );
 
    if( success )
    {
        manager.ReloadTables( scope, { LIBRARY_TABLE_TYPE::SYMBOL } );
        adapter->LoadOne( aLibNickname );
    }
 
    return success;
}
 
 
bool SYMBOL_EDIT_FRAME::IsSymbolAlias() const
{
    return m_symbol && !m_symbol->IsRoot();
}
 
 
bool SYMBOL_EDIT_FRAME::IsSymbolEditable() const
{
    return m_symbol && ( !IsSymbolFromLegacyLibrary() || IsSymbolFromSchematic() );
}
 
 
void SYMBOL_EDIT_FRAME::UpdateItem( EDA_ITEM* aItem, bool isAddOrDelete, bool aUpdateRtree )
{
    SCH_BASE_FRAME::UpdateItem( aItem, isAddOrDelete, aUpdateRtree );
 
    if( EDA_TEXT* eda_text = dynamic_cast<EDA_TEXT*>( aItem ) )
    {
        eda_text->ClearBoundingBoxCache();
        eda_text->ClearRenderCache();
    }
}
 
 
void SYMBOL_EDIT_FRAME::updateSelectionFilterVisbility()
{
    wxAuiPaneInfo& treePane = m_auimgr.GetPane( m_treePane );
    wxAuiPaneInfo& propertiesPane = m_auimgr.GetPane( PropertiesPaneName() );
    wxAuiPaneInfo& selectionFilterPane = m_auimgr.GetPane( wxS( "SelectionFilter" ) );
 
    // Don't give the selection filter its own visibility controls; instead show it if
    // anything else is visible
    bool showFilter = ( treePane.IsShown() && treePane.IsDocked() )
                      || ( propertiesPane.IsShown() && propertiesPane.IsDocked() );
 
    selectionFilterPane.Show( showFilter );
}
 
 
bool SYMBOL_EDIT_FRAME::GetShowInvisibleFields()
{
    // Returns the current render option for invisible fields
    return libeditconfig()->m_ShowHiddenFields;
}
 
 
bool SYMBOL_EDIT_FRAME::GetShowInvisiblePins()
{
    // Returns the current render option for invisible pins
    return libeditconfig()->m_ShowHiddenPins;
}