footprint_libraries_utils.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#include <memory>
#include <wx/ffile.h>
#include <pgm_base.h>
#include <kiface_base.h>
#include <confirm.h>
#include <kidialog.h>
#include <macros.h>
#include <pcb_edit_frame.h>
#include <eda_list_dialog.h>
#include <filter_reader.h>
#include <footprint_library_adapter.h>
#include <validators.h>
#include <dialogs/dialog_text_entry.h>
#include <tool/tool_manager.h>
#include <tools/pcb_actions.h>
#include <tools/board_editor_control.h>
#include <tools/pad_tool.h>
#include <footprint.h>
#include <zone.h>
#include <pcb_group.h>
#include <footprint_edit_frame.h>
#include <wildcards_and_files_ext.h>
#include <pcb_io/kicad_sexpr/pcb_io_kicad_sexpr.h>
#include <widgets/filedlg_hook_new_library.h>
#include <env_paths.h>
#include <paths.h>
#include <settings/settings_manager.h>
#include <kiplatform/ui.h>
#include <project_pcb.h>
#include <project/project_file.h>
#include <footprint_editor_settings.h>
#include <footprint_viewer_frame.h>
#include <io/kicad/kicad_io_utils.h>
#include <view/view_controls.h>
#include <wx/filedlg.h>
#include <wx/fswatcher.h>
 
 
static constexpr int ID_MAKE_NEW_LIBRARY = 4173;
 
 
// unique, "file local" translations:
 
 
static const wxString INFO_LEGACY_LIB_WARN_EDIT(
        _(  "Writing/modifying legacy libraries (.mod files) is not allowed\n"\
            "Please save the current library to the new .pretty format\n"\
            "and update your footprint lib table\n"\
            "to save your footprint (a .kicad_mod file) in the .pretty library folder" ) );
 
static const wxString INFO_LEGACY_LIB_WARN_DELETE(
        _(  "Modifying legacy libraries (.mod files) is not allowed\n"\
            "Please save the current library under the new .pretty format\n"\
            "and update your footprint lib table\n"\
            "before deleting a footprint" ) );
 
 
FOOTPRINT* FOOTPRINT_EDIT_FRAME::ImportFootprint( const wxString& aName )
{
    wxFileName fn;
 
    if( !aName.empty() )
    {
        fn = aName;
    }
    else
    {
        // Prompt the user for a footprint file to open.
        static int               lastFilterIndex = 0; // To store the last choice during a session.
        wxString                 fileFiltersStr;
        std::vector<std::string> allExtensions;
        std::set<wxString>       allWildcardsSet;
 
        for( const auto& plugin : PCB_IO_MGR::PLUGIN_REGISTRY::Instance()->AllPlugins() )
        {
            IO_RELEASER<PCB_IO> pi( plugin.m_createFunc() );
 
            if( !pi )
                continue;
 
            const IO_BASE::IO_FILE_DESC& desc = pi->GetLibraryFileDesc();
 
            if( !desc )
                continue;
 
            if( !fileFiltersStr.IsEmpty() )
                fileFiltersStr += wxChar( '|' );
 
            fileFiltersStr += desc.FileFilter();
 
            for( const std::string& ext : desc.m_FileExtensions )
            {
                allExtensions.emplace_back( ext );
                allWildcardsSet.insert( wxT( "*." ) + formatWildcardExt( ext ) + wxT( ";" ) );
            }
        }
 
        wxString allWildcardsStr;
 
        for( const wxString& wildcard : allWildcardsSet )
            allWildcardsStr << wildcard;
 
        fileFiltersStr = _( "All supported formats" ) + wxT( "|" ) + allWildcardsStr + wxT( "|" )
                         + fileFiltersStr;
 
        wxFileDialog dlg( this, _( "Import Footprint" ), m_mruPath, wxEmptyString, fileFiltersStr,
                          wxFD_OPEN | wxFD_FILE_MUST_EXIST );
 
        wxArrayString dummy1, dummy2;
        const int nWildcards = wxParseCommonDialogsFilter( fileFiltersStr, dummy1, dummy2 );
 
        if( lastFilterIndex >= 0 && lastFilterIndex < nWildcards )
            dlg.SetFilterIndex( lastFilterIndex );
 
        KIPLATFORM::UI::AllowNetworkFileSystems( &dlg );
 
        if( dlg.ShowModal() == wxID_CANCEL )
            return nullptr;
 
        lastFilterIndex = dlg.GetFilterIndex();
 
        fn = dlg.GetPath();
    }
 
    if( !fn.IsOk() )
        return nullptr;
 
    if( !wxFileExists( fn.GetFullPath() ) )
    {
        wxString msg = wxString::Format( _( "File '%s' not found." ), fn.GetFullPath() );
        DisplayError( this, msg );
        return nullptr;
    }
 
    m_mruPath = fn.GetPath();
 
    PCB_IO_MGR::PCB_FILE_T fileType = PCB_IO_MGR::FILE_TYPE_NONE;
 
    for( const auto& plugin : PCB_IO_MGR::PLUGIN_REGISTRY::Instance()->AllPlugins() )
    {
        IO_RELEASER<PCB_IO> pi( plugin.m_createFunc() );
 
        if( !pi )
            continue;
 
        if( pi->GetLibraryFileDesc().m_FileExtensions.empty() )
            continue;
 
        if( pi->CanReadFootprint( fn.GetFullPath() ) )
        {
            fileType = plugin.m_type;
            break;
        }
    }
 
    if( fileType == PCB_IO_MGR::FILE_TYPE_NONE )
    {
        DisplayError( this, _( "Not a footprint file." ) );
        return nullptr;
    }
 
    FOOTPRINT* footprint = nullptr;
    wxString   footprintName;
 
    try
    {
        IO_RELEASER<PCB_IO> pi( PCB_IO_MGR::FindPlugin( fileType ) );
 
        footprint = pi->ImportFootprint( fn.GetFullPath(), footprintName);
 
        if( !footprint )
        {
            wxString msg = wxString::Format( _( "Unable to load footprint '%s' from '%s'" ),
                                             footprintName, fn.GetFullPath() );
            DisplayError( this, msg );
            return nullptr;
        }
    }
    catch( const IO_ERROR& ioe )
    {
        DisplayError( this, ioe.What() );
 
        // if the footprint is not loaded, exit.
        // However, even if an error happens, it can be loaded, because in KICAD and GPCB format,
        // a fp library is a set of separate files, and the error(s) are not necessary when
        // reading the selected file
 
        if( !footprint )
            return nullptr;
    }
 
    footprint->SetFPID( LIB_ID( wxEmptyString, footprintName ) );
 
    // Insert footprint in list
    AddFootprintToBoard( footprint );
 
    // Display info :
    SetMsgPanel( footprint );
    PlaceFootprint( footprint );
 
    footprint->SetPosition( VECTOR2I( 0, 0 ) );
 
    GetBoard()->BuildListOfNets();
    UpdateView();
 
    return footprint;
}
 
 
void FOOTPRINT_EDIT_FRAME::ExportFootprint( FOOTPRINT* aFootprint )
{
    wxFileName fn;
    FOOTPRINT_EDITOR_SETTINGS* cfg = GetSettings();
 
    if( !aFootprint )
        return;
 
    fn.SetName( aFootprint->GetFPID().GetLibItemName() );
 
    wxString wildcard = FILEEXT::KiCadFootprintLibFileWildcard();
 
    fn.SetExt( FILEEXT::KiCadFootprintFileExtension );
 
    if( !cfg->m_LastExportPath.empty() )
        fn.SetPath( cfg->m_LastExportPath );
    else
        fn.SetPath( m_mruPath );
 
    wxFileDialog dlg( this, _( "Export Footprint" ), fn.GetPath(), fn.GetFullName(),
                      wildcard, wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
 
    KIPLATFORM::UI::AllowNetworkFileSystems( &dlg );
 
    if( dlg.ShowModal() == wxID_CANCEL )
        return;
 
    fn = EnsureFileExtension( dlg.GetPath(), FILEEXT::KiCadFootprintFileExtension );
    cfg->m_LastExportPath = fn.GetPath();
 
    try
    {
        // Export as *.kicad_pcb format, using a strategy which is specifically chosen
        // as an example on how it could also be used to send it to the system clipboard.
 
        PCB_IO_KICAD_SEXPR  pcb_io(CTL_FOR_LIBRARY );
 
        /*  This footprint should *already* be "normalized" in a way such that
            orientation is zero, etc., since it came from the Footprint Editor.
 
            aFootprint->SetParent( 0 );
            aFootprint->SetOrientation( 0 );
        */
 
        pcb_io.Format( aFootprint );
 
        FILE* fp = wxFopen( dlg.GetPath(), wxT( "wt" ) );
 
        if( fp == nullptr )
        {
            DisplayErrorMessage( this, wxString::Format( _( "Insufficient permissions to write file '%s'." ),
                                                         dlg.GetPath() ) );
            return;
        }
 
        std::string prettyData = pcb_io.GetStringOutput( false );
        KICAD_FORMAT::Prettify( prettyData, KICAD_FORMAT::FORMAT_MODE::NORMAL );
 
        fprintf( fp, "%s", prettyData.c_str() );
        fclose( fp );
    }
    catch( const IO_ERROR& ioe )
    {
        DisplayError( this, ioe.What() );
        return;
    }
 
    wxString msg = wxString::Format( _( "Footprint exported to file '%s'." ), dlg.GetPath() );
    DisplayInfoMessage( this, msg );
}
 
 
wxString PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary( const wxString& aDialogTitle, const wxString& aLibName )
{
    return createNewLibrary( aDialogTitle, aLibName, wxEmptyString, LIBRARY_TABLE_SCOPE::PROJECT );
}
 
 
wxString PCB_BASE_EDIT_FRAME::CreateNewLibrary( const wxString& aDialogTitle, const wxString& aInitialPath )
{
    return createNewLibrary( aDialogTitle, wxEmptyString, aInitialPath );
}
 
 
wxString PCB_BASE_EDIT_FRAME::createNewLibrary( const wxString& aDialogTitle, const wxString& aLibName,
                                                const wxString& aInitialPath, std::optional<LIBRARY_TABLE_SCOPE> aScope )
{
    // Kicad cannot write legacy format libraries, only .pretty new format because the legacy
    // format cannot handle current features.
    // The footprint library is actually a directory.
 
    wxFileName                fn;
    bool                      doAdd = false;
    bool                      isGlobal = false;
    FILEDLG_HOOK_NEW_LIBRARY  tableChooser( isGlobal );
    FILEDLG_HOOK_NEW_LIBRARY* fileDlgHook = &tableChooser;
 
    if( aScope )
        fileDlgHook = nullptr;
 
    if( aLibName.IsEmpty() )
    {
        fn = aInitialPath.IsEmpty() ? Prj().GetProjectPath() : aInitialPath;
 
        if( !LibraryFileBrowser( aDialogTitle, false, fn, FILEEXT::KiCadFootprintLibPathWildcard(),
                                 FILEEXT::KiCadFootprintLibPathExtension, false, fileDlgHook ) )
        {
            return wxEmptyString;
        }
 
        if( fileDlgHook )
        {
            isGlobal = fileDlgHook->GetUseGlobalTable();
            aScope = isGlobal ? LIBRARY_TABLE_SCOPE::GLOBAL : LIBRARY_TABLE_SCOPE::PROJECT;
        }
 
        doAdd = true;
    }
    else
    {
        fn = EnsureFileExtension( aLibName, FILEEXT::KiCadFootprintLibPathExtension );
 
        if( !fn.IsAbsolute() )
        {
            fn.SetName( aLibName );
            fn.MakeAbsolute( Prj().GetProjectPath() );
        }
    }
 
    // We can save fp libs only using PCB_IO_MGR::KICAD_SEXP format (.pretty libraries)
    PCB_IO_MGR::PCB_FILE_T piType  = PCB_IO_MGR::KICAD_SEXP;
    wxString               libPath = fn.GetFullPath();
 
    try
    {
        IO_RELEASER<PCB_IO> pi( PCB_IO_MGR::FindPlugin( piType ) );
 
        bool writable = false;
        bool exists   = false;
 
        try
        {
            writable = pi->IsLibraryWritable( libPath );
            exists   = true;    // no exception was thrown, lib must exist.
        }
        catch( const IO_ERROR& )
        {
            // best efforts....
        }
 
        if( exists )
        {
            if( !writable )
            {
                wxString msg = wxString::Format( _( "Library %s is read only." ), libPath );
                ShowInfoBarError( msg );
                return wxEmptyString;
            }
            else
            {
                wxString msg = wxString::Format( _( "Library %s already exists." ), libPath );
                KIDIALOG dlg( this, msg, _( "Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
                dlg.SetOKLabel( _( "Overwrite" ) );
                dlg.DoNotShowCheckbox( __FILE__, __LINE__ );
 
                if( dlg.ShowModal() == wxID_CANCEL )
                    return wxEmptyString;
 
                pi->DeleteLibrary( libPath );
            }
        }
 
        pi->CreateLibrary( libPath );
    }
    catch( const IO_ERROR& ioe )
    {
        DisplayError( this, ioe.What() );
        return wxEmptyString;
    }
 
    if( doAdd )
        AddLibrary( aDialogTitle, libPath, aScope );
 
    return libPath;
}
 
 
wxString PCB_BASE_EDIT_FRAME::SelectLibrary( const wxString& aDialogTitle, const wxString& aListLabel,
                                             const std::vector<std::pair<wxString, bool*>>& aExtraCheckboxes )
{
    // Keep asking the user for a new name until they give a valid one or cancel the operation
    while( true )
    {
        wxArrayString              headers;
        std::vector<wxArrayString> itemsToDisplay;
 
        GetLibraryItemsForListDialog( headers, itemsToDisplay );
 
        wxString libraryName = Prj().GetRString( PROJECT::PCB_LIB_NICKNAME );
 
        EDA_LIST_DIALOG dlg( this, aDialogTitle, headers, itemsToDisplay, libraryName, false );
        dlg.SetListLabel( aListLabel );
 
        for( const auto& [label, val] : aExtraCheckboxes )
            dlg.AddExtraCheckbox( label, val );
 
        wxButton* newLibraryButton = new wxButton( &dlg, ID_MAKE_NEW_LIBRARY, _( "New Library..." ) );
        dlg.m_ButtonsSizer->Prepend( 80, 20 );
        dlg.m_ButtonsSizer->Prepend( newLibraryButton, 0, wxALIGN_CENTER_VERTICAL|wxLEFT|wxRIGHT, 10 );
 
        newLibraryButton->Bind( wxEVT_BUTTON,
                [&dlg]( wxCommandEvent& )
                {
                    dlg.EndModal( ID_MAKE_NEW_LIBRARY );
                }, ID_MAKE_NEW_LIBRARY );
 
        dlg.Layout();
        dlg.GetSizer()->Fit( &dlg );
 
        int ret = dlg.ShowModal();
 
        switch( ret )
        {
        case wxID_CANCEL:
            return wxEmptyString;
 
        case wxID_OK:
            libraryName = dlg.GetTextSelection();
            Prj().SetRString( PROJECT::PCB_LIB_NICKNAME, libraryName );
            dlg.GetExtraCheckboxValues();
            return libraryName;
 
        case ID_MAKE_NEW_LIBRARY:
        {
            wxFileName fn = CreateNewLibrary( _( "New Footprint Library" ),
                                              Prj().GetRString( PROJECT::PCB_LIB_PATH ) );
 
            Prj().SetRString( PROJECT::PCB_LIB_PATH, fn.GetPath() );
            Prj().SetRString( PROJECT::PCB_LIB_NICKNAME, fn.GetName() );
            break;
        }
 
        default:
            break;
        }
    }
}
 
 
bool PCB_BASE_EDIT_FRAME::AddLibrary( const wxString& aDialogTitle, const wxString& aFilename,
                                      std::optional<LIBRARY_TABLE_SCOPE> aScope )
{
    FOOTPRINT_LIBRARY_ADAPTER* adapter = PROJECT_PCB::FootprintLibAdapter( &Prj() );
    LIBRARY_MANAGER&           manager = Pgm().GetLibraryManager();
    bool                       isGlobal = false;
    FILEDLG_HOOK_NEW_LIBRARY   tableChooser( isGlobal );
    FILEDLG_HOOK_NEW_LIBRARY*  fileDlgHook = &tableChooser;
 
    if( aScope )
    {
        isGlobal = ( *aScope == LIBRARY_TABLE_SCOPE::GLOBAL );
        fileDlgHook = nullptr;
    }
 
    wxFileName fn( aFilename );
 
    if( aFilename.IsEmpty() )
    {
        if( !LibraryFileBrowser( aDialogTitle, true, fn, FILEEXT::KiCadFootprintLibPathWildcard(),
                                 FILEEXT::KiCadFootprintLibPathExtension, true, fileDlgHook ) )
        {
            return false;
        }
 
        if( fileDlgHook )
            isGlobal = fileDlgHook->GetUseGlobalTable();
    }
 
    aScope = isGlobal ? LIBRARY_TABLE_SCOPE::GLOBAL : LIBRARY_TABLE_SCOPE::PROJECT;
 
    wxString libPath = fn.GetFullPath();
    wxString libName = fn.GetName();
 
    if( libName.IsEmpty() )
        return false;
 
    PCB_IO_MGR::PCB_FILE_T lib_type = PCB_IO_MGR::GuessPluginTypeFromLibPath( libPath );
 
    if( lib_type == PCB_IO_MGR::FILE_TYPE_NONE )
        lib_type = PCB_IO_MGR::KICAD_SEXP;
 
    wxString type = PCB_IO_MGR::ShowType( lib_type );
 
    // KiCad lib is our default guess.  So it might not have the .pretty extension
    // In this case, the extension is part of the library name
    if( lib_type == PCB_IO_MGR::KICAD_SEXP && fn.GetExt() != FILEEXT::KiCadFootprintLibPathExtension )
        libName = fn.GetFullName();
 
    // try to use path normalized to an environmental variable or project path
    wxString normalizedPath = NormalizePath( libPath, &Pgm().GetLocalEnvVariables(), &Prj() );
    bool     success = true;
 
    try
    {
        std::optional<LIBRARY_TABLE*> optTable = manager.Table( LIBRARY_TABLE_TYPE::FOOTPRINT, aScope.value() );
 
        if( !optTable )
            return false;
 
        LIBRARY_TABLE* table = optTable.value();
 
        LIBRARY_TABLE_ROW& row = table->InsertRow();
 
        row.SetNickname( libName );
        row.SetURI( normalizedPath );
        row.SetType( type );
 
        table->Save().map_error(
                [&]( const LIBRARY_ERROR& aError )
                {
                    wxMessageBox( _( "Error saving library table:\n\n" ) + aError.message,
                                  _( "File Save Error" ), wxOK | wxICON_ERROR );
                    success = false;
                } );
    }
    catch( const IO_ERROR& ioe )
    {
        DisplayError( this, ioe.What() );
        return false;
    }
 
    if( success )
    {
        manager.ReloadTables( aScope.value(), { LIBRARY_TABLE_TYPE::FOOTPRINT } );
        adapter->LoadOne( fn.GetName() );
 
        // Don't use dynamic_cast; it will fail across compile units on MacOS
        if( FOOTPRINT_EDIT_FRAME* editor = (FOOTPRINT_EDIT_FRAME*) Kiway().Player( FRAME_FOOTPRINT_EDITOR, false ) )
        {
            LIB_ID libID( libName, wxEmptyString );
            editor->SyncLibraryTree( true );
            editor->FocusOnLibID( libID );
        }
 
        auto viewer = (FOOTPRINT_VIEWER_FRAME*) Kiway().Player( FRAME_FOOTPRINT_VIEWER, false );
 
        if( viewer )
            viewer->ReCreateLibraryList();
    }
 
    return success;
}
 
 
bool FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary( const LIB_ID& aFPID, bool aConfirm )
{
    if( !aFPID.IsValid() )
        return false;
 
    LIBRARY_MANAGER& manager = Pgm().GetLibraryManager();
    FOOTPRINT_LIBRARY_ADAPTER* adapter = PROJECT_PCB::FootprintLibAdapter( &Prj() );
 
    wxString nickname = aFPID.GetLibNickname();
    wxString fpname = aFPID.GetLibItemName();
    wxString libfullname;
 
    // Legacy libraries are readable, but modifying legacy format is not allowed
    // So prompt the user if he try to delete a footprint from a legacy lib
    if( std::optional<wxString> optUri = manager.GetFullURI( LIBRARY_TABLE_TYPE::FOOTPRINT, nickname ) )
        libfullname = *optUri;
    else
        return false;
 
    if( PCB_IO_MGR::GuessPluginTypeFromLibPath( libfullname ) == PCB_IO_MGR::LEGACY )
    {
        DisplayInfoMessage( this, INFO_LEGACY_LIB_WARN_DELETE );
        return false;
    }
 
    if( !adapter->IsFootprintLibWritable( nickname ) )
    {
        wxString msg = wxString::Format( _( "Library '%s' is read only." ), nickname );
        ShowInfoBarError( msg );
        return false;
    }
 
    // Confirmation
    wxString msg = wxString::Format( _( "Delete footprint '%s' from library '%s'?" ),
                                     fpname.GetData(),
                                     nickname.GetData() );
 
    if( aConfirm && !IsOK( this, msg ) )
        return false;
 
    try
    {
        adapter->DeleteFootprint( nickname, fpname );
    }
    catch( const IO_ERROR& ioe )
    {
        DisplayError( this, ioe.What() );
        return false;
    }
 
    msg.Printf( _( "Footprint '%s' deleted from library '%s'" ),
                fpname.GetData(),
                nickname.GetData() );
 
    SetStatusText( msg );
 
    return true;
}
 
 
void PCB_EDIT_FRAME::ExportFootprintsToLibrary( bool aStoreInNewLib, const wxString& aLibName,
                                                wxString* aLibPath )
{
    if( GetBoard()->GetFirstFootprint() == nullptr )
    {
        DisplayInfoMessage( this, _( "No footprints to export!" ) );
        return;
    }
 
    bool     map = false;
    PROJECT& prj = Prj();
    wxString nickname = SelectLibrary( _( "Export Footprints" ), _( "Export footprints to library:" ),
                                       { { _( "Update board footprints to link to exported footprints" ), &map } } );
 
    if( !nickname )     // Aborted
        return;
 
    prj.SetRString( PROJECT::PCB_LIB_NICKNAME, nickname );
 
    for( FOOTPRINT* footprint : GetBoard()->Footprints() )
    {
        try
        {
            FOOTPRINT_LIBRARY_ADAPTER* adapter = PROJECT_PCB::FootprintLibAdapter( &Prj() );
 
            if( !footprint->GetFPID().GetLibItemName().empty() )    // Handle old boards.
            {
                FOOTPRINT* fpCopy = static_cast<FOOTPRINT*>( footprint->Duplicate( IGNORE_PARENT_GROUP ) );
 
                // Reset reference designator, group membership, and zone offset before saving
 
                fpCopy->SetReference( "REF**" );
                fpCopy->SetParentGroup( nullptr );
 
                for( ZONE* zone : fpCopy->Zones() )
                    zone->Move( -fpCopy->GetPosition() );
 
                adapter->SaveFootprint( nickname, fpCopy, true );
 
                delete fpCopy;
            }
        }
        catch( const IO_ERROR& ioe )
        {
            DisplayError( this, ioe.What() );
        }
 
        if( map )
        {
            LIB_ID id = footprint->GetFPID();
            id.SetLibNickname( nickname );
            footprint->SetFPID( id );
        }
    }
}
 
 
bool FOOTPRINT_EDIT_FRAME::SaveFootprint( FOOTPRINT* aFootprint )
{
    if( !aFootprint )      // Happen if no footprint loaded
        return false;
 
    PAD_TOOL* padTool = m_toolManager->GetTool<PAD_TOOL>();
 
    if( padTool->InPadEditMode() )
        m_toolManager->RunAction( PCB_ACTIONS::recombinePad );
 
    wxString libraryName = aFootprint->GetFPID().GetLibNickname();
    wxString footprintName = aFootprint->GetFPID().GetLibItemName();
    bool     nameChanged = m_footprintNameWhenLoaded != footprintName;
 
    if( aFootprint->GetLink() != niluuid )
    {
        if( SaveFootprintToBoard( false ) )
        {
            m_footprintNameWhenLoaded = footprintName;
            return true;
        }
 
        return false;
    }
    else if( libraryName.IsEmpty() || footprintName.IsEmpty() )
    {
        if( SaveFootprintAs( aFootprint ) )
        {
            m_footprintNameWhenLoaded = footprintName;
            SyncLibraryTree( true );
            return true;
        }
 
        return false;
    }
 
    LIBRARY_MANAGER& manager = Pgm().GetLibraryManager();
 
    // Legacy libraries are readable, but modifying legacy format is not allowed
    // So prompt the user if he try to add/replace a footprint in a legacy lib
    wxString libfullname;
 
    if( std::optional<wxString> optUri = manager.GetFullURI( LIBRARY_TABLE_TYPE::FOOTPRINT, libraryName ) )
        libfullname = *optUri;
    else
        return false;
 
    if( PCB_IO_MGR::GuessPluginTypeFromLibPath( libfullname ) == PCB_IO_MGR::LEGACY )
    {
        DisplayInfoMessage( this, INFO_LEGACY_LIB_WARN_EDIT );
        return false;
    }
 
    if( nameChanged )
    {
        LIB_ID oldFPID( libraryName, m_footprintNameWhenLoaded );
        DeleteFootprintFromLibrary( oldFPID, false );
    }
 
    if( !SaveFootprintInLibrary( aFootprint, libraryName ) )
        return false;
 
    if( nameChanged )
    {
        m_footprintNameWhenLoaded = footprintName;
        SyncLibraryTree( true );
    }
 
    return true;
}
 
 
bool FOOTPRINT_EDIT_FRAME::DuplicateFootprint( FOOTPRINT* aFootprint )
{
    LIBRARY_MANAGER& manager = Pgm().GetLibraryManager();
    FOOTPRINT_LIBRARY_ADAPTER* adapter = PROJECT_PCB::FootprintLibAdapter( &Prj() );
 
    LIB_ID     fpID = aFootprint->GetFPID();
    wxString   libraryName = fpID.GetLibNickname();
    wxString   footprintName = fpID.GetLibItemName();
 
    // Legacy libraries are readable, but modifying legacy format is not allowed
    // So prompt the user if he try to add/replace a footprint in a legacy lib
    if( std::optional<wxString> optUri = manager.GetFullURI( LIBRARY_TABLE_TYPE::FOOTPRINT, libraryName ) )
    {
        if( PCB_IO_MGR::GuessPluginTypeFromLibPath( *optUri ) == PCB_IO_MGR::LEGACY )
        {
            DisplayInfoMessage( this, INFO_LEGACY_LIB_WARN_EDIT );
            return false;
        }
    }
    else
    {
        return false;
    }
 
    int           i = 1;
    wxString      newName = footprintName;
 
    // Append a number to the name until the name is unique in the library.
    while( adapter->FootprintExists( libraryName, newName ) )
        newName.Printf( "%s_%d", footprintName, i++ );
 
    aFootprint->SetFPID( LIB_ID( libraryName, newName ) );
 
    if( aFootprint->GetValue() == footprintName )
        aFootprint->SetValue( newName );
 
    return SaveFootprintInLibrary( aFootprint, libraryName );
}
 
 
bool FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary( FOOTPRINT* aFootprint,
                                                   const wxString& aLibraryName )
{
    try
    {
        aFootprint->SetFPID( LIB_ID( wxEmptyString, aFootprint->GetFPID().GetLibItemName() ) );
 
        // Clear selected, brightened, temp flags, edit flags, the whole shebang.
        aFootprint->RunOnChildren(
                []( BOARD_ITEM* child )
                {
                    child->ClearFlags();
                },
                RECURSE_MODE::RECURSE );
 
        FOOTPRINT_LIBRARY_ADAPTER* adapter = PROJECT_PCB::FootprintLibAdapter( &Prj() );
        adapter->SaveFootprint( aLibraryName, aFootprint );
 
        aFootprint->SetFPID( LIB_ID( aLibraryName, aFootprint->GetFPID().GetLibItemName() ) );
 
        if( aFootprint == GetBoard()->GetFirstFootprint() )
            setFPWatcher( aFootprint );
 
        return true;
    }
    catch( const IO_ERROR& ioe )
    {
        DisplayError( this, ioe.What() );
 
        aFootprint->SetFPID( LIB_ID( aLibraryName, aFootprint->GetFPID().GetLibItemName() ) );
        return false;
    }
}
 
 
bool FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard( bool aAddNew )
{
    // update footprint in the current board,
    // not just add it to the board with total disregard for the netlist...
    PCB_EDIT_FRAME* pcbframe = (PCB_EDIT_FRAME*) Kiway().Player( FRAME_PCB_EDITOR, false );
 
    if( pcbframe == nullptr )       // happens when the board editor is not active (or closed)
    {
        ShowInfoBarError( _( "No board currently open." ) );
        return false;
    }
 
    BOARD*     mainpcb  = pcbframe->GetBoard();
    FOOTPRINT* sourceFootprint  = nullptr;
    FOOTPRINT* editorFootprint = GetBoard()->GetFirstFootprint();
 
    if( !editorFootprint )
        return false;
 
    // Search the old footprint (source) if exists
    // Because this source could be deleted when editing the main board...
    if( editorFootprint->GetLink() != niluuid )        // this is not a new footprint ...
    {
        sourceFootprint = nullptr;
 
        for( FOOTPRINT* candidate : mainpcb->Footprints() )
        {
            if( editorFootprint->GetLink() == candidate->m_Uuid )
            {
                sourceFootprint = candidate;
                break;
            }
        }
    }
 
    if( !aAddNew && sourceFootprint == nullptr )    // source not found
    {
        DisplayError( this, _( "Unable to find the footprint on the main board.\nCannot save." ) );
        return false;
    }
 
    TOOL_MANAGER* pcb_ToolManager = pcbframe->GetToolManager();
 
    if( aAddNew && pcb_ToolManager->GetTool<BOARD_EDITOR_CONTROL>()->PlacingFootprint() )
    {
        DisplayError( this, _( "Previous footprint placement still in progress." ) );
        return false;
    }
 
    m_toolManager->RunAction( ACTIONS::selectionClear );
    BOARD_COMMIT commit( pcbframe );
 
    // Create a copy for the board, first using Clone() to keep existing Uuids, and then either
    // resetting the uuids to the board values or assigning new Uuids.
    FOOTPRINT* newFootprint = static_cast<FOOTPRINT*>( editorFootprint->Clone() );
    newFootprint->SetParent( mainpcb );
    newFootprint->SetLink( niluuid );
 
    auto fixUuid =
            [&]( KIID& aUuid )
            {
                if( editorFootprint->GetLink() != niluuid && m_boardFootprintUuids.count( aUuid ) )
                    aUuid = m_boardFootprintUuids[ aUuid ];
                else
                    aUuid = KIID();
            };
 
    {
        KIID uuid = newFootprint->m_Uuid;
        fixUuid( uuid );
        newFootprint->SetUuid( uuid );
    }
 
    newFootprint->RunOnChildren(
            [&]( BOARD_ITEM* aChild )
            {
                KIID uuid = aChild->m_Uuid;
                fixUuid( uuid );
                aChild->SetUuid( uuid );
            },
            RECURSE_MODE::RECURSE );
 
    // Right now, we only show the "Unconnected" net in the footprint editor, but this is still
    // referenced in the footprint.  So we need to update the net pointers in the footprint to
    // point to the nets in the main board.
    newFootprint->RunOnChildren(
            [&]( BOARD_ITEM* aChild )
            {
                if( BOARD_CONNECTED_ITEM* conn = dynamic_cast<BOARD_CONNECTED_ITEM*>( aChild ) )
                {
                    NETINFO_ITEM* net = conn->GetNet();
                    auto& netmap = mainpcb->GetNetInfo().NetsByName();
 
                    if( net )
                    {
                        auto it = netmap.find( net->GetNetname() );
 
                        if( it != netmap.end() )
                            conn->SetNet( it->second );
                    }
 
                }
            },
            RECURSE_MODE::RECURSE );
 
    BOARD_DESIGN_SETTINGS& bds = m_pcb->GetDesignSettings();
 
    newFootprint->ApplyDefaultSettings( *m_pcb, bds.m_StyleFPFields, bds.m_StyleFPText,
                                        bds.m_StyleFPShapes, bds.m_StyleFPDimensions,
                                        bds.m_StyleFPBarcodes );
 
    if( sourceFootprint )         // this is an update command
    {
        // In the main board the new footprint replaces the old one (pos, orient, ref, value,
        // connections and properties are kept) and the sourceFootprint (old footprint) is
        // deleted
        pcbframe->ExchangeFootprint( sourceFootprint, newFootprint, commit, true );
        commit.Push( _( "Update Footprint" ) );
    }
    else        // This is an insert command
    {
        KIGFX::VIEW_CONTROLS* viewControls = pcbframe->GetCanvas()->GetViewControls();
        VECTOR2D              cursorPos = viewControls->GetCursorPosition();
 
        commit.Add( newFootprint );
        viewControls->SetCrossHairCursorPosition( VECTOR2D( 0, 0 ), false );
        pcbframe->PlaceFootprint( newFootprint );
        newFootprint->SetPosition( VECTOR2I( 0, 0 ) );
        viewControls->SetCrossHairCursorPosition( cursorPos, false );
        newFootprint->ResetUuid();
        commit.Push( _( "Insert Footprint" ) );
 
        pcbframe->Raise();
        pcb_ToolManager->RunAction( PCB_ACTIONS::placeFootprint, newFootprint );
    }
 
    newFootprint->ClearFlags();
 
    return true;
}
 
 
class SAVE_AS_DIALOG : public EDA_LIST_DIALOG
{
public:
    SAVE_AS_DIALOG( FOOTPRINT_EDIT_FRAME* aParent, const wxString& aFootprintName,
                    const wxString& aLibraryPreselect,
                    std::function<bool( wxString libName, wxString fpName )> aValidator ) :
            EDA_LIST_DIALOG( aParent, _( "Save Footprint As" ), false ),
            m_validator( std::move( aValidator ) )
    {
        FOOTPRINT_LIBRARY_ADAPTER* adapter = PROJECT_PCB::FootprintLibAdapter( &Prj() );
        std::vector<wxString>      nicknames = adapter->GetLibraryNames();
        wxArrayString              headers;
        std::vector<wxArrayString> itemsToDisplay;
 
        aParent->GetLibraryItemsForListDialog( headers, itemsToDisplay );
        initDialog( headers, itemsToDisplay, aLibraryPreselect );
 
        SetListLabel( _( "Save in library:" ) );
        SetOKLabel( _( "Save" ) );
 
        wxBoxSizer* bNameSizer = new wxBoxSizer( wxHORIZONTAL );
 
        wxStaticText* label = new wxStaticText( this, wxID_ANY, _( "Name:" ) );
        bNameSizer->Add( label, 0, wxALIGN_CENTER_VERTICAL|wxTOP|wxBOTTOM|wxLEFT, 5 );
 
        m_fpNameCtrl = new wxTextCtrl( this, wxID_ANY, aFootprintName );
        bNameSizer->Add( m_fpNameCtrl, 1, wxALIGN_CENTER_VERTICAL|wxALL, 5 );
 
        wxTextValidator nameValidator( wxFILTER_EXCLUDE_CHAR_LIST );
        nameValidator.SetCharExcludes( FOOTPRINT::StringLibNameInvalidChars( false ) );
        m_fpNameCtrl->SetValidator( nameValidator );
 
        wxButton* newLibraryButton = new wxButton( this, ID_MAKE_NEW_LIBRARY, _( "New Library..." ) );
        m_ButtonsSizer->Prepend( 80, 20 );
        m_ButtonsSizer->Prepend( newLibraryButton, 0, wxALIGN_CENTER_VERTICAL|wxLEFT|wxRIGHT, 10 );
 
        GetSizer()->Prepend( bNameSizer, 0, wxEXPAND|wxTOP|wxLEFT|wxRIGHT, 5 );
 
        // If a footprint name was specified, disable loading of previously-saved state
        if( !aFootprintName.IsEmpty() )
            OptOut( m_fpNameCtrl );
 
        Bind( wxEVT_BUTTON,
                [this]( wxCommandEvent& )
                {
                    EndModal( ID_MAKE_NEW_LIBRARY );
                }, ID_MAKE_NEW_LIBRARY );
 
        // Move nameTextCtrl to the head of the tab-order
        if( GetChildren().DeleteObject( m_fpNameCtrl ) )
            GetChildren().Insert( m_fpNameCtrl );
 
        SetInitialFocus( m_fpNameCtrl );
 
        SetupStandardButtons();
 
        Layout();
        GetSizer()->Fit( this );
 
        Centre();
    }
 
    wxString GetFPName()
    {
        wxString footprintName = m_fpNameCtrl->GetValue();
        footprintName.Trim( true );
        footprintName.Trim( false );
        return footprintName;
    }
 
protected:
    bool TransferDataToWindow() override
    {
        // Respond to any filter text loaded from previously-saved state
        wxCommandEvent dummy;
        textChangeInFilterBox( dummy );
 
        return true;
    }
 
    bool TransferDataFromWindow() override
    {
        return m_validator( GetTextSelection(), GetFPName() );
    }
 
private:
    wxTextCtrl*                                              m_fpNameCtrl;
    std::function<bool( wxString libName, wxString fpName )> m_validator;
};
 
 
bool FOOTPRINT_EDIT_FRAME::SaveFootprintAs( FOOTPRINT* aFootprint )
{
    if( aFootprint == nullptr )
        return false;
 
    LIBRARY_MANAGER& manager = Pgm().GetLibraryManager();
    FOOTPRINT_LIBRARY_ADAPTER* adapter = PROJECT_PCB::FootprintLibAdapter( &Prj() );
 
    SetMsgPanel( aFootprint );
 
    wxString libraryName = aFootprint->GetFPID().GetLibNickname();
    wxString footprintName = aFootprint->GetFPID().GetLibItemName();
    bool     updateValue = aFootprint->GetValue() == footprintName;
    bool     done = false;
    bool     footprintExists = false;
 
    while( !done )
    {
        SAVE_AS_DIALOG dlg( this, footprintName, libraryName,
                [&]( const wxString& newLib, const wxString& newName )
                {
                    if( newLib.IsEmpty() )
                    {
                        wxMessageBox( _( "A library must be specified." ) );
                        return false;
                    }
 
                    if( newName.IsEmpty() )
                    {
                        wxMessageBox( _( "Footprint must have a name." ) );
                        return false;
                    }
 
                    // Legacy libraries are readable, but modifying legacy format is not allowed
                    // So prompt the user if he try to add/replace a footprint in a legacy lib
                    if( std::optional<wxString> optUri = manager.GetFullURI( LIBRARY_TABLE_TYPE::FOOTPRINT, newLib ) )
                    {
                        if( PCB_IO_MGR::GuessPluginTypeFromLibPath( *optUri ) == PCB_IO_MGR::LEGACY )
                        {
                            DisplayInfoMessage( this, INFO_LEGACY_LIB_WARN_EDIT );
                            return false;
                        }
                    }
                    else
                    {
                        return false;
                    }
 
                    footprintExists = adapter->FootprintExists( newLib, newName );
 
                    if( footprintExists )
                    {
                        wxString msg = wxString::Format( _( "Footprint %s already exists in %s." ),
                                                         newName,
                                                         newLib );
 
                        KIDIALOG errorDlg( this, msg, _( "Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
                        errorDlg.SetOKLabel( _( "Overwrite" ) );
 
                        return errorDlg.ShowModal() == wxID_OK;
                    }
 
                    return true;
                } );
 
        int ret = dlg.ShowModal();
 
        if( ret == wxID_CANCEL )
        {
            return false;
        }
        else if( ret == wxID_OK )
        {
            footprintName = dlg.GetFPName();
            libraryName = dlg.GetTextSelection();
            done = true;
        }
        else if( ret == ID_MAKE_NEW_LIBRARY )
        {
            wxFileName fn = CreateNewLibrary( _( "New Footprint Library" ),
                                              Prj().GetRString( PROJECT::PCB_LIB_PATH ) );
 
            Prj().SetRString( PROJECT::PCB_LIB_PATH, fn.GetPath() );
            Prj().SetRString( PROJECT::PCB_LIB_NICKNAME, fn.GetName() );
            libraryName = fn.GetName();
        }
    }
 
    aFootprint->SetFPID( LIB_ID( libraryName, footprintName ) );
 
    if( updateValue )
        aFootprint->SetValue( footprintName );
 
    if( !SaveFootprintInLibrary( aFootprint, libraryName ) )
        return false;
 
    // Once saved-as a board footprint is no longer a board footprint
    aFootprint->SetLink( niluuid );
 
    wxString fmt = footprintExists ? _( "Footprint '%s' replaced in '%s'" )
                                   : _( "Footprint '%s' added to '%s'" );
 
    wxString msg = wxString::Format( fmt, footprintName.GetData(), libraryName.GetData() );
    SetStatusText( msg );
    UpdateTitle();
    ReCreateHToolbar();
 
    return true;
}
 
 
bool FOOTPRINT_EDIT_FRAME::RevertFootprint()
{
    if( GetScreen()->IsContentModified() && m_originalFootprintCopy )
    {
        wxString msg = wxString::Format( _( "Revert '%s' to last version saved?" ),
                                         GetLoadedFPID().GetLibItemName().wx_str() );
 
        if( ConfirmRevertDialog( this, msg ) )
        {
            Clear_Pcb( false );
            AddFootprintToBoard( static_cast<FOOTPRINT*>( m_originalFootprintCopy->Clone() ) );
 
            Zoom_Automatique( false );
 
            Update3DView( true, true );
 
            ClearUndoRedoList();
            GetScreen()->SetContentModified( false );
 
            UpdateView();
            GetCanvas()->Refresh();
 
            return true;
        }
    }
 
    return false;
}
 
 
FOOTPRINT* PCB_BASE_FRAME::CreateNewFootprint( wxString aFootprintName, const wxString& aLibName )
{
    if( aFootprintName.IsEmpty() )
        aFootprintName = _( "Untitled" );
 
    int footprintAttrs = FP_SMD;
 
    if( !aLibName.IsEmpty() )
    {
        FOOTPRINT_LIBRARY_ADAPTER* adapter = PROJECT_PCB::FootprintLibAdapter( &Prj() );
        std::vector<wxString> fpnames;
        wxString      baseName = aFootprintName;
        int           idx = 1;
 
        // Make sure the name is unique
        while( adapter->FootprintExists( aLibName, aFootprintName ) )
            aFootprintName = baseName + wxString::Format( wxS( "_%d" ), idx++ );
 
        // Try to infer the footprint attributes from an existing footprint in the library
        try
        {
            fpnames = adapter->GetFootprintNames( aLibName, true );
 
            if( !fpnames.empty() )
            {
                std::unique_ptr<FOOTPRINT> fp( adapter->LoadFootprint( aLibName, fpnames.back(), false ) );
 
                if( fp )
                    footprintAttrs = fp->GetAttributes();
            }
        }
        catch( ... )
        {
            // best efforts
        }
    }
 
    // Create the new footprint and add it to the head of the linked list of footprints
    FOOTPRINT* footprint = new FOOTPRINT( GetBoard() );
 
    // Update its name in lib
    footprint->SetFPID( LIB_ID( wxEmptyString, aFootprintName ) );
 
    footprint->SetAttributes( footprintAttrs );
 
    PCB_LAYER_ID txt_layer;
    VECTOR2I     default_pos;
    BOARD_DESIGN_SETTINGS& settings = GetDesignSettings();
 
    if( settings.m_DefaultFPTextItems.size() > 0 )
    {
        footprint->Reference().SetText( settings.m_DefaultFPTextItems[0].m_Text );
        footprint->Reference().SetVisible( settings.m_DefaultFPTextItems[0].m_Visible );
    }
 
    txt_layer = settings.m_DefaultFPTextItems[0].m_Layer;
    footprint->Reference().SetLayer( txt_layer );
    default_pos.y -= settings.GetTextSize( txt_layer ).y / 2;
    footprint->Reference().SetPosition( default_pos );
    default_pos.y += settings.GetTextSize( txt_layer ).y;
 
    if( settings.m_DefaultFPTextItems.size() > 1 )
    {
        footprint->Value().SetText( settings.m_DefaultFPTextItems[1].m_Text );
        footprint->Value().SetVisible( settings.m_DefaultFPTextItems[1].m_Visible );
    }
 
    txt_layer = settings.m_DefaultFPTextItems[1].m_Layer;
    footprint->Value().SetLayer( txt_layer );
    default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
    footprint->Value().SetPosition( default_pos );
    default_pos.y += settings.GetTextSize( txt_layer ).y;
 
    for( size_t i = 2; i < settings.m_DefaultFPTextItems.size(); ++i )
    {
        PCB_TEXT* textItem = new PCB_TEXT( footprint );
        textItem->SetText( settings.m_DefaultFPTextItems[i].m_Text );
        txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[i].m_Layer;
        textItem->SetLayer( txt_layer );
        default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
        textItem->SetPosition( default_pos );
        default_pos.y += settings.GetTextSize( txt_layer ).y;
        footprint->GraphicalItems().push_back( textItem );
    }
 
    if( footprint->GetReference().IsEmpty() )
        footprint->SetReference( aFootprintName );
 
    if( footprint->GetValue().IsEmpty() )
        footprint->SetValue( aFootprintName );
 
    footprint->RunOnChildren(
            [&]( BOARD_ITEM* aChild )
            {
                if( aChild->Type() == PCB_FIELD_T || aChild->Type() == PCB_TEXT_T )
                {
                    PCB_TEXT*    textItem = static_cast<PCB_TEXT*>( aChild );
                    PCB_LAYER_ID layer = textItem->GetLayer();
 
                    textItem->SetTextThickness( settings.GetTextThickness( layer ) );
                    textItem->SetTextSize( settings.GetTextSize( layer ) );
                    textItem->SetItalic( settings.GetTextItalic( layer ) );
                    textItem->SetKeepUpright( settings.GetTextUpright( layer ) );
                }
            },
            RECURSE_MODE::RECURSE );
 
    SetMsgPanel( footprint );
    return footprint;
}
 
 
void PCB_BASE_FRAME::GetLibraryItemsForListDialog( wxArrayString& aHeaders,
                                                   std::vector<wxArrayString>& aItemsToDisplay )
{
    aHeaders.Add( _( "Library" ) );
    aHeaders.Add( _( "Description" ) );
 
    COMMON_SETTINGS*           cfg = Pgm().GetCommonSettings();
    PROJECT_FILE&              project = Kiway().Prj().GetProjectFile();
    FOOTPRINT_LIBRARY_ADAPTER* adapter = PROJECT_PCB::FootprintLibAdapter( &Prj() );
    std::vector<wxString>      nicknames = adapter->GetLibraryNames();
    std::vector<wxArrayString> unpinned;
 
    for( const wxString& nickname : nicknames )
    {
        wxArrayString item;
        wxString      description = adapter->GetLibraryDescription( nickname ).value_or( wxEmptyString );
 
        if( alg::contains( project.m_PinnedFootprintLibs, nickname )
                || alg::contains( cfg->m_Session.pinned_fp_libs, nickname ) )
        {
            item.Add( LIB_TREE_MODEL_ADAPTER::GetPinningSymbol() + nickname );
            item.Add( description );
            aItemsToDisplay.push_back( item );
        }
        else
        {
            item.Add( nickname );
            item.Add( description );
            unpinned.push_back( item );
        }
    }
 
    std::ranges::copy( unpinned, std::back_inserter( aItemsToDisplay ) );
}