startwizard_provider_libraries.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.
 * @author Jon Evans <[email protected]>
 *
 * 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 3 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 <pgm_base.h>
#include <bitmaps/bitmaps_list.h>
#include <bitmaps/bitmap_types.h>
#include <dialogs/panel_startwizard_libraries_base.h>
#include <libraries/library_manager.h>
#include <paths.h>
#include <startwizard/startwizard.h>
#include <startwizard/startwizard_provider_libraries.h>
 
#include <magic_enum.hpp>
#include <startwizard/startwizard_provider_settings.h>
#include <trace_helpers.h>
#include <regex>
#include <set>
#include <wx/log.h>
 
 
class PANEL_STARTWIZARD_LIBRARIES : public PANEL_STARTWIZARD_LIBRARIES_BASE
{
public:
    PANEL_STARTWIZARD_LIBRARIES( const std::shared_ptr<STARTWIZARD_PROVIDER_LIBRARIES_MODEL>& aModel,
                                 wxWindow* aParent, STARTWIZARD* aWizard ) :
            PANEL_STARTWIZARD_LIBRARIES_BASE( aParent ),
            m_model( aModel ),
            m_wizard( aWizard )
    {
        wxWindowBase::SetMaxSize( { FromDIP( 640 ), -1 } );
        m_bmpWarning->SetBitmap( KiBitmapBundle( BITMAPS::dialog_warning ) );
        m_sizerWarning->Layout();
 
        Bind( wxEVT_RADIOBUTTON, &PANEL_STARTWIZARD_LIBRARIES::OnModeChanged, this,
              m_rbDefaultTables->GetId() );
        Bind( wxEVT_RADIOBUTTON, &PANEL_STARTWIZARD_LIBRARIES::OnModeChanged, this,
              m_rbImport->GetId() );
        Bind( wxEVT_RADIOBUTTON, &PANEL_STARTWIZARD_LIBRARIES::OnModeChanged, this,
              m_rbBlankTables->GetId() );
 
        m_introText = m_stIntro->GetLabel();
        m_warningText = m_stWarning->GetLabel();
 
        InitTableListMsg();
        m_bmpWarning->Show( m_showWarning );
        m_stWarning->Show( m_showWarning );
 
        m_containingSizer->Fit( this );
        SetSize( GetBestSize() );
    }
 
    bool TransferDataFromWindow() override
    {
        if( m_rbDefaultTables->GetValue() )
            m_model->mode = STARTWIZARD_LIBRARIES_MODE::USE_DEFAULTS;
        else if( m_rbImport->GetValue() )
            m_model->mode = STARTWIZARD_LIBRARIES_MODE::IMPORT;
        else
            m_model->mode = STARTWIZARD_LIBRARIES_MODE::CREATE_BLANK;
 
        m_model->mode_initialized = true;
 
        m_model->migrate_built_in_libraries = m_cbMigrateBuiltInLibraries->GetValue();
 
        return true;
    }
 
    bool TransferDataToWindow() override
    {
        if( !m_model->mode_initialized )
        {
            // If the user is importing settings from a previous version, let's default to taking their
            // library settings as well, since we can clean up old stock paths now.
            if( auto settings = dynamic_cast<STARTWIZARD_PROVIDER_SETTINGS*>( m_wizard->GetProvider( "settings" ) ) )
            {
                if( settings->NeedsUserInput() )
                    m_model->mode = STARTWIZARD_LIBRARIES_MODE::IMPORT;
                else
                    m_model->mode = STARTWIZARD_LIBRARIES_MODE::USE_DEFAULTS;
            }
 
            m_model->mode_initialized = true;
        }
 
        switch( m_model->mode )
        {
        case STARTWIZARD_LIBRARIES_MODE::USE_DEFAULTS:  m_rbDefaultTables->SetValue( true ); break;
        case STARTWIZARD_LIBRARIES_MODE::IMPORT:        m_rbImport->SetValue( true );        break;
        case STARTWIZARD_LIBRARIES_MODE::CREATE_BLANK:  m_rbBlankTables->SetValue( true );   break;
        }
 
        m_cbMigrateBuiltInLibraries->SetValue( m_model->migrate_built_in_libraries );
 
        if( auto settings = dynamic_cast<STARTWIZARD_PROVIDER_SETTINGS*>( m_wizard->GetProvider( "settings" ) ) )
        {
            if( !settings->NeedsUserInput() )
            {
                // If the user didn't see the settings screen at all, just hide this option; we
                // only offer import when we have the context of a previous version settings
                // path selected by the user
                m_rbImport->Show( false );
                m_cbMigrateBuiltInLibraries->Show( false );
            }
            else if( settings->GetModel().mode == STARTWIZARD_SETTINGS_MODE::USE_DEFAULTS )
            {
                // But if they did see the screen and chose not to import, show the option but
                // disable it as a breadcrumb that they can go back and choose to import settings
                m_rbImport->Disable();
 
                if( m_rbImport->GetValue() )
                    m_rbDefaultTables->SetValue( true );
            }
            else
            {
                m_rbImport->Enable();
            }
        }
 
        UpdateMigrateCheckboxState();
 
        m_bmpWarning->Show( m_showWarning );
        m_stWarning->Show( m_showWarning );
 
        return true;
    }
 
    void InitTableListMsg()
    {
        wxString missingTablesText;
        m_showWarning = false;
 
        for( const LIBRARY_TABLE_TYPE& type : m_model->missing_tables )
        {
            if( !LIBRARY_MANAGER::IsTableValid( LIBRARY_MANAGER::StockTablePath( type ) )
                && type != LIBRARY_TABLE_TYPE::DESIGN_BLOCK )
            {
                wxLogTrace( traceLibraries, wxT( "Stock table path for %s is not valid; will show warning" ),
                            magic_enum::enum_name( type ) );
                m_showWarning = true;
            }
 
            switch( type )
            {
            case LIBRARY_TABLE_TYPE::SYMBOL:
                missingTablesText.Append( _( "Symbol library table" ) + "\n" );
                break;
 
            case LIBRARY_TABLE_TYPE::FOOTPRINT:
                missingTablesText.Append( _( "Footprint library table" ) + "\n" );
                break;
 
            case LIBRARY_TABLE_TYPE::DESIGN_BLOCK:
                missingTablesText.Append( _( "Design Block library table" ) + "\n" );
                break;
 
            case LIBRARY_TABLE_TYPE::UNINITIALIZED:
                break;
            }
        }
 
        m_stRequiredTables->SetLabel( missingTablesText.BeforeLast( '\n' ) );
    }
 
    void OnSize( wxSizeEvent& aEvt ) override
    {
        aEvt.Skip();
 
        // Wrapping is destructive and the size can change a few times during construction, at least
        // on macOS.  Resetting the label makes wrapping work properly.
        m_stIntro->SetLabel( m_introText );
        m_stWarning->SetLabel( m_warningText );
 
#if defined( __WXMAC__ )
        m_stIntro->Wrap( GetClientSize().x - FromDIP( 20 ) );
        m_stWarning->Wrap( GetClientSize().x - m_bmpWarning->GetSize().x - FromDIP( 28 ) );
#elif defined( __WXMSW__ )
        m_stIntro->Wrap( GetClientSize().x );
        m_stWarning->Wrap( GetClientSize().x - m_bmpWarning->GetSize().x - FromDIP( 10 ) );
#else
        m_stIntro->Wrap( GetClientSize().x - FromDIP( 10 ) );
        m_stWarning->Wrap( GetClientSize().x - m_bmpWarning->GetSize().x - FromDIP( 18 ) );
#endif
    }
 
private:
    void OnModeChanged( wxCommandEvent& aEvt )
    {
        aEvt.Skip();
        UpdateMigrateCheckboxState();
    }
 
    void UpdateMigrateCheckboxState()
    {
        m_cbMigrateBuiltInLibraries->Enable( m_rbImport->IsShown()
                                             && m_rbImport->IsEnabled()
                                             && m_rbImport->GetValue() );
    }
 
    std::shared_ptr<STARTWIZARD_PROVIDER_LIBRARIES_MODEL> m_model;
    STARTWIZARD* m_wizard;
    bool m_showWarning;
    wxString m_introText;
    wxString m_warningText;
};
 
 
STARTWIZARD_PROVIDER_LIBRARIES::STARTWIZARD_PROVIDER_LIBRARIES() :
        STARTWIZARD_PROVIDER( _( "Libraries" ) )
{
}
 
 
bool STARTWIZARD_PROVIDER_LIBRARIES::NeedsUserInput() const
{
    return !LIBRARY_MANAGER::GlobalTablesValid();
}
 
 
wxPanel* STARTWIZARD_PROVIDER_LIBRARIES::GetWizardPanel( wxWindow* aParent, STARTWIZARD* aWizard )
{
    m_model = std::make_shared<STARTWIZARD_PROVIDER_LIBRARIES_MODEL>();
    m_model->missing_tables = LIBRARY_MANAGER::InvalidGlobalTables();
    return new PANEL_STARTWIZARD_LIBRARIES( m_model, aParent, aWizard );
}
 
 
bool STARTWIZARD_PROVIDER_LIBRARIES::MigrateBuiltInLibraries( LIBRARY_TABLE& aTable, LIBRARY_TABLE_TYPE aType,
                                                              const wxString& aStockPath, bool aStockPathValid )
{
    const std::regex builtInPattern( aType == LIBRARY_TABLE_TYPE::SYMBOL
            ? R"(^\$\{KICAD\d+_SYMBOL_DIR\})"
            : R"(^\$\{KICAD\d+_FOOTPRINT_DIR\})" );
 
    // Only re-introduce the stock libraries if the imported table actually referenced them.
    // A user who removed all built-in libraries in the previous version should not have them
    // silently added back during migration.
    bool insertStock = false;
    bool haveChained = false;
    bool chainedRepointed = false;
    std::set<wxString> toRemove;
 
    for( LIBRARY_TABLE_ROW& row : aTable.Rows() )
    {
        if( std::regex_search( row.URI().ToStdString(), builtInPattern ) )
        {
            toRemove.insert( row.URI() );
            insertStock = true;
            wxLogTrace( traceLibraries, wxT( "Libraries migration: removing old stock row '%s'" ), row.URI() );
        }
        else if( row.Type() == LIBRARY_TABLE_ROW::TABLE_TYPE_NAME && row.Nickname() == wxT( "KiCad" ) )
        {
            haveChained = true;
 
            if( row.URI().Matches( aStockPath ) )
            {
                wxLogTrace( traceLibraries,
                            wxT( "Libraries migration: migrated table already has latest stock setup" ) );
            }
            else if( LIBRARY_MANAGER::IsTableValid( row.URI() ) && !aStockPathValid )
            {
                wxLogTrace( traceLibraries,
                            wxT( "Libraries migration: migrated table has working stock table at "
                                 "'%s' but calculated stock path '%s' is missing or invalid.  Leaving alone." ),
                            row.URI(), aStockPath );
            }
            else
            {
                wxLogTrace( traceLibraries,
                            wxT( "Libraries migration: migrated chained table URI from '%s' to '%s'" ),
                            row.URI(), aStockPath );
                row.SetDescription( _( "KiCad Default Libraries" ) );
                row.SetURI( aStockPath );
                chainedRepointed = true;
            }
        }
    }
 
    auto toErase = std::ranges::remove_if( aTable.Rows(),
            [&]( const LIBRARY_TABLE_ROW& aRow )
            {
                return toRemove.contains( aRow.URI() );
            } );
 
    aTable.Rows().erase( toErase.begin(), toErase.end() );
 
    // An existing chained reference was already migrated in place, so don't add a second one.
    if( haveChained )
        insertStock = false;
 
    if( insertStock )
    {
        wxLogTrace( traceLibraries, wxT( "Libraries migration: inserting chained default table" ) );
        LIBRARY_TABLE_ROW chained = aTable.MakeRow();
        chained.SetType( LIBRARY_TABLE_ROW::TABLE_TYPE_NAME );
        chained.SetNickname( wxT( "KiCad" ) );
        chained.SetDescription( _( "KiCad Default Libraries" ) );
        chained.SetURI( aStockPath );
        aTable.Rows().insert( aTable.Rows().begin(), chained );
    }
 
    return !toRemove.empty() || insertStock || chainedRepointed;
}
 
 
void STARTWIZARD_PROVIDER_LIBRARIES::Finish()
{
    bool populateTables = m_model->mode == STARTWIZARD_LIBRARIES_MODE::USE_DEFAULTS;
 
    if( m_model->mode == STARTWIZARD_LIBRARIES_MODE::IMPORT && m_model->migrate_built_in_libraries )
    {
        for( LIBRARY_TABLE_TYPE type : { LIBRARY_TABLE_TYPE::SYMBOL, LIBRARY_TABLE_TYPE::FOOTPRINT } )
        {
            wxString tablePath = LIBRARY_MANAGER::DefaultGlobalTablePath( type );
            wxString stockPath = LIBRARY_MANAGER::StockTablePath( type );
 
            if( !LIBRARY_MANAGER::IsTableValid( tablePath ) )
                continue;
 
            wxFileName tableFile( tablePath );
            LIBRARY_TABLE table( tableFile, LIBRARY_TABLE_SCOPE::GLOBAL );
 
            if( !table.IsOk() )
                continue;
 
            if( MigrateBuiltInLibraries( table, type, stockPath, LIBRARY_MANAGER::IsTableValid( stockPath ) ) )
                table.Save();
            else
                wxLogTrace( traceLibraries, wxT( "Libraries migration: no actions needed" ) );
        }
    }
 
    for( LIBRARY_TABLE_TYPE type : LIBRARY_MANAGER::InvalidGlobalTables() )
    {
        LIBRARY_MANAGER::CreateGlobalTable( type, populateTables );
    }
}
 
 
void STARTWIZARD_PROVIDER_LIBRARIES::ApplyDefaults()
{
    for( LIBRARY_TABLE_TYPE type : LIBRARY_MANAGER::InvalidGlobalTables() )
    {
        LIBRARY_MANAGER::CreateGlobalTable( type, true );
    }
}