kicad/eeschema/sim/sim_lib_mgr.cpp

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2022 Mikolaj Wielgus
 * Copyright (C) 2022 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 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, you may find one here:
 * https://www.gnu.org/licenses/gpl-3.0.html
 * or you may search the http://www.gnu.org website for the version 3 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

#include <sim/sim_lib_mgr.h>
#include <sch_symbol.h>
#include <sim/sim_library.h>
#include <sim/sim_model.h>
#include <pgm_base.h>
#include <string>


SIM_LIB_MGR::SIM_LIB_MGR( const PROJECT& aPrj ) : m_project( aPrj )
{
}


SIM_LIBRARY::MODEL SIM_LIB_MGR::CreateModel( const SCH_SHEET_PATH* aSheetPath, SCH_SYMBOL& aSymbol,
                                             bool aResolve )
{
    int         pinCount = aSymbol.GetLibPins().size();
    SCH_FIELD*  libraryField = aSymbol.FindField( SIM_LIBRARY::LIBRARY_FIELD );
    std::string baseModelName;

    std::vector<SCH_FIELD> fields;

    for( int i = 0; i < aSymbol.GetFieldCount(); ++i )
    {
        fields.emplace_back( VECTOR2I(), i, &aSymbol, aSymbol.GetFields()[ i ].GetName() );

        if( i == REFERENCE_FIELD )
            fields.back().SetText( aSymbol.GetRef( aSheetPath ) );
        else if( i == VALUE_FIELD )
            fields.back().SetText( aSymbol.GetValue( aSheetPath, aResolve ) );
        else if( i == FOOTPRINT_FIELD )
            fields.back().SetText( aSymbol.GetFootprint( aSheetPath, aResolve ) );
        else if( aResolve )
            fields.back().SetText( aSymbol.GetFields()[ i ].GetShownText( 0, false ) );
        else
            fields.back().SetText( aSymbol.GetFields()[ i ].GetText() );
    }

    if( libraryField )
    {
        wxString path = libraryField->GetShownText();
        wxString absolutePath = m_project.AbsolutePath( path );
        SIM_LIBRARY* library = nullptr;

        try
        {
            auto it = m_libraries.try_emplace( std::string( path.ToUTF8() ),
                    SIM_LIBRARY::Create( std::string( absolutePath.ToUTF8() ) ) ).first;
            library = &*it->second;
        }
        catch( const IO_ERROR& e )
        {
            THROW_IO_ERROR( wxString::Format( _( "Error loading simulation model library '%s': %s" ),
                                              absolutePath,
                                              e.What() ) );
        }

        SCH_FIELD* nameField = aSymbol.FindField( SIM_LIBRARY::NAME_FIELD );

        if( !nameField )
        {
            THROW_IO_ERROR( wxString::Format( _( "Error loading simulation model: no '%s' field" ),
                                              SIM_LIBRARY::NAME_FIELD ) );
        }

        baseModelName = std::string( nameField->GetShownText().ToUTF8() );
        SIM_MODEL* baseModel = library->FindModel( baseModelName );

        if( !baseModel )
        {
            THROW_IO_ERROR( wxString::Format( _( "Error loading simulation model: could not find "
                                                 "base model '%s' in library '%s'" ),
                                              baseModelName,
                                              absolutePath ) );
        }

        m_models.push_back( SIM_MODEL::Create( *baseModel, pinCount, fields, aResolve ) );
    }
    else
    {
        m_models.push_back( SIM_MODEL::Create( pinCount, fields, aResolve ) );
    }

    return { baseModelName, *m_models.back() };
}


SIM_LIBRARY& SIM_LIB_MGR::CreateLibrary( const std::string& aLibraryPath )
{
    auto it = m_libraries.try_emplace( aLibraryPath, SIM_LIBRARY::Create( aLibraryPath ) ).first;
    return *it->second;
}


std::map<std::string, std::reference_wrapper<const SIM_LIBRARY>> SIM_LIB_MGR::GetLibraries() const
{
    std::map<std::string, std::reference_wrapper<const SIM_LIBRARY>> result;

    for( auto&& [path, library] : m_libraries )
        result.try_emplace( path, *library );

    return result;
}