eeschema_helpers.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 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 "eeschema_helpers.h"
 
#include <algorithm>
 
#include <connection_graph.h>
#include <locale_io.h>
#include <libraries/legacy_symbol_library.h>
#include <libraries/symbol_library_adapter.h>
#include <project/project_file.h>
#include <schematic.h>
#include <reporter.h>
#include <sch_commit.h>
#include <sch_edit_frame.h>
#include <sch_file_versions.h>
#include <sch_label.h>
#include <sch_io/sch_io.h>
#include <sch_io/sch_io_mgr.h>
#include <settings/settings_manager.h>
#include <wildcards_and_files_ext.h>
#include <tool/tool_manager.h>
#include <kiface_base.h>
 
#include <wx/app.h>
#include <reporter.h>
 
 
SCH_EDIT_FRAME*   EESCHEMA_HELPERS::s_SchEditFrame = nullptr;
 
 
void EESCHEMA_HELPERS::SetSchEditFrame( SCH_EDIT_FRAME* aSchEditFrame )
{
    s_SchEditFrame = aSchEditFrame;
}
 
 
SCHEMATIC* EESCHEMA_HELPERS::LoadSchematic( const wxString& aFileName, bool aSetActive,
                                            bool aForceDefaultProject, PROJECT* aProject,
                                            bool aCalculateConnectivity, REPORTER* aRootReporter )
{
    if( aFileName.EndsWith( FILEEXT::KiCadSchematicFileExtension ) )
        return LoadSchematic( aFileName, SCH_IO_MGR::SCH_KICAD, aSetActive, aForceDefaultProject,
                              aProject, aCalculateConnectivity, aRootReporter );
    else if( aFileName.EndsWith( FILEEXT::LegacySchematicFileExtension ) )
        return LoadSchematic( aFileName, SCH_IO_MGR::SCH_LEGACY, aSetActive, aForceDefaultProject,
                              aProject, aCalculateConnectivity, aRootReporter );
 
    // as fall back for any other kind use the legacy format
    return LoadSchematic( aFileName, SCH_IO_MGR::SCH_LEGACY, aSetActive, aForceDefaultProject, aProject,
                          aCalculateConnectivity, aRootReporter );
}
 
 
static const TOP_LEVEL_SHEET_INFO* findDeclaredTopLevelSheet(
        const std::vector<TOP_LEVEL_SHEET_INFO>& aProjectSheets, const wxString& aProjectPath,
        const wxFileName& aFile )
{
    for( const TOP_LEVEL_SHEET_INFO& info : aProjectSheets )
    {
        wxFileName candidate( aProjectPath, info.filename );
        candidate.MakeAbsolute();
 
        if( candidate.SameAs( aFile ) )
            return &info;
    }
 
    return nullptr;
}
 
 
SCHEMATIC* EESCHEMA_HELPERS::LoadSchematic( const wxString& aFileName,
                                            SCH_IO_MGR::SCH_FILE_T aFormat,
                                            bool aSetActive,
                                            bool aForceDefaultProject,
                                            PROJECT* aProject,
                                            bool aCalculateConnectivity, REPORTER* aRootReporter )
{
    wxFileName pro = aFileName;
    pro.SetExt( FILEEXT::ProjectFileExtension );
    pro.MakeAbsolute();
    wxString projectPath = pro.GetFullPath();
 
    // Ensure the "C" locale is temporary set, before reading any file
    // It also avoid wxWidget alerts about locale issues, later, when using Python 3
    LOCALE_IO dummy;
 
    PROJECT* project = aProject;
    SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
 
    if( !project )
    {
        project = mgr.GetProject( projectPath );
    }
 
    if( !aForceDefaultProject )
    {
        if( !project )
        {
            if( wxFileExists( projectPath ) )
            {
                mgr.LoadProject( projectPath, aSetActive );
                project = mgr.GetProject( projectPath );
            }
        }
        else if( s_SchEditFrame && project == &mgr.Prj() )
        {
            // Project is already loaded?  Then so is the board
            return &s_SchEditFrame->Schematic();
        }
    }
 
    // Board cannot be loaded without a project, so create the default project
    if( !project || aForceDefaultProject )
        project = &mgr.Prj();
 
    IO_RELEASER<SCH_IO> pi( SCH_IO_MGR::FindPlugin( aFormat ) );
 
    std::unique_ptr<SCHEMATIC> schematic = std::make_unique<SCHEMATIC>( project );
    schematic->CreateDefaultScreens();
 
    wxFileName schFile = aFileName;
    schFile.MakeAbsolute();
 
    try
    {
        const wxString                           projectDir = project->GetProjectPath();
        const std::vector<TOP_LEVEL_SHEET_INFO>& projectSheets =
                project->GetProjectFile().GetTopLevelSheets();
        const TOP_LEVEL_SHEET_INFO* namedSheet = findDeclaredTopLevelSheet( projectSheets,
                                                                           projectDir, schFile );
        std::vector<SCH_SHEET*> loadedSheets;
        const auto loadSheet = [&]( const wxString& aPath, bool aDeclaredRoot )
        {
            SCH_SHEET* sheet = pi->LoadSchematicFile( aPath, schematic.get() );
 
            if( !sheet || !aRootReporter || aFormat != SCH_IO_MGR::SCH_KICAD
                || sheet->GetScreen()->GetFileFormatVersionAtLoad() < 20221110 )
                return sheet;
 
            const SCH_SCREEN& screen = *sheet->GetScreen();
            wxString error;
 
            if( !screen.GetSheetInstances().empty() )
            {
                error = wxString::Format( _( "Schematic '%s' has a malformed root sheet instance path." ), aPath );
            }
            else if( !sheet->HasRootInstance() && !aDeclaredRoot )
            {
                bool parentPlacement = false;
                bool rootPlacement = false;
                const auto inspectPlacements = [&]( const auto& instances )
                {
                    for( const auto& instance : instances )
                    {
                        parentPlacement |= instance.m_Path.size() > 1;
                        rootPlacement |= instance.m_Path.size() == 1
                                         && instance.m_Path.front() == screen.GetUuid();
                    }
                };
 
                for( SCH_ITEM* item : screen.Items() )
                {
                    if( item->Type() == SCH_SYMBOL_T )
                        inspectPlacements( static_cast<SCH_SYMBOL*>( item )->GetInstances() );
                    else if( item->Type() == SCH_SHEET_T )
                        inspectPlacements( static_cast<SCH_SHEET*>( item )->GetInstances() );
                }
 
                if( parentPlacement && !rootPlacement )
                    error = wxString::Format(
                            _( "Schematic '%s' is a hierarchical subsheet; load its root schematic." ), aPath );
            }
 
            if( !error.IsEmpty() )
            {
                delete sheet;
 
                for( SCH_SHEET* loaded : loadedSheets )
                    delete loaded;
 
                aRootReporter->Report( error, RPT_SEVERITY_ERROR );
                THROW_IO_ERROR( error );
            }
 
            return sheet;
        };
 
        // Load every declared top-level sheet so headless callers plot what the GUI does
        // A missing named file still fails to load rather than falling back to its siblings
        if( projectSheets.size() > 1 && namedSheet && schFile.FileExists() )
        {
            for( const TOP_LEVEL_SHEET_INFO& info : projectSheets )
            {
                wxFileName sheetFn( projectDir, info.filename );
                sheetFn.MakeAbsolute();
 
                if( !sheetFn.FileExists() )
                    continue;
 
                SCH_SHEET* sheet = loadSheet( sheetFn.GetFullPath(), true );
 
                if( !sheet )
                    continue;
 
                // Sub-sheet instance paths key off this UUID, so only a nil entry keeps the loaded one
                if( info.uuid != niluuid )
                    const_cast<KIID&>( sheet->m_Uuid ) = info.uuid;
 
                if( !info.name.IsEmpty() )
                    sheet->SetName( info.name );
 
                loadedSheets.push_back( sheet );
            }
        }
 
        if( !loadedSheets.empty() )
        {
            schematic->SetTopLevelSheets( loadedSheets );
        }
        else
        {
            SCH_SHEET* rootSheet = loadSheet( schFile.GetFullPath(), namedSheet != nullptr );
 
            if( !rootSheet )
            {
                schematic->SetProject( nullptr );
                return nullptr;
            }
 
            std::vector<SCH_SHEET*> topLevelSheets = schematic->GetTopLevelSheets();
            bool rootIsTopLevel = std::find( topLevelSheets.begin(), topLevelSheets.end(),
                                             rootSheet ) != topLevelSheets.end();
            bool rootIsVirtualRoot = rootSheet == &schematic->Root()
                                     || rootSheet->IsVirtualRootSheet();
 
            if( !rootIsTopLevel && !rootIsVirtualRoot )
                schematic->SetTopLevelSheets( { rootSheet } );
 
            // Make ${SHEETNAME} work on the root sheet until we properly support naming it
            if( rootSheet->GetName().IsEmpty() )
            {
                if( namedSheet && !namedSheet->name.IsEmpty() )
                    rootSheet->SetName( namedSheet->name );
                else
                    rootSheet->SetName( _( "Root" ) );
            }
        }
    }
    catch( ... )
    {
        schematic->SetProject( nullptr );
        return nullptr;
    }
 
    SCH_SHEET_LIST sheetList = schematic->BuildSheetListSortedByPageNumbers();
    SCH_SCREENS    screens( schematic->Root() );
 
    if( aFormat == SCH_IO_MGR::SCH_LEGACY )
    {
        LIBRARY_MANAGER libraries( project );
        libraries.RegisterAdapter( LIBRARY_TABLE_TYPE::SYMBOL,
                                    std::make_unique<SYMBOL_LIBRARY_ADAPTER>( libraries ) );
        libraries.LoadGlobalTables( { LIBRARY_TABLE_TYPE::SYMBOL } );
        libraries.LoadProjectTables( { LIBRARY_TABLE_TYPE::SYMBOL } );
        auto* adapter = static_cast<SYMBOL_LIBRARY_ADAPTER*>(
                libraries.Adapter( LIBRARY_TABLE_TYPE::SYMBOL ).value() );
        LEGACY_SYMBOL_LIBS legacyLibs;
        const wxString cache = LEGACY_SYMBOL_LIBS::CacheName( schFile.GetFullPath() );
 
        if( !cache.IsEmpty() )
        {
            LEGACY_SYMBOL_LIB* library = legacyLibs.AddLibrary( cache );
 
            if( !library )
            {
                schematic->SetProject( nullptr );
                return nullptr;
            }
 
            library->SetCache();
        }
 
        for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
        {
            screen->UpdateSymbolLinks( nullptr, &legacyLibs, adapter );
 
            for( SCH_ITEM* item : screen->Items().OfType( SCH_SYMBOL_T ) )
            {
                if( !static_cast<SCH_SYMBOL*>( item )->GetLibSymbolRef() )
                {
                    schematic->SetProject( nullptr );
                    return nullptr;
                }
            }
        }
    }
    else
    {
        for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
            screen->UpdateLocalLibSymbolLinks();
    }
 
    if( schematic->RootScreen()->GetFileFormatVersionAtLoad() < 20221002 )
        sheetList.UpdateSymbolInstanceData( schematic->RootScreen()->GetSymbolInstances());
 
    sheetList.UpdateSheetInstanceData( schematic->RootScreen()->GetSheetInstances());
 
    if( schematic->RootScreen()->GetFileFormatVersionAtLoad() < 20230221 )
        screens.FixLegacyPowerSymbolMismatches();
 
    for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
        screen->MigrateSimModels();
 
    schematic->LoadVariants();
 
    wxString projectName = project->GetProjectName();
 
    if( projectName.IsEmpty() )
        projectName = schFile.GetName();
 
    // Check must run before pruning so variant data on a stale instance path is migrated
    // onto the new instance before the orphan is removed.
    sheetList.CheckForMissingSymbolInstances( projectName );
    screens.PruneOrphanedSymbolInstances( projectName, sheetList );
    screens.PruneOrphanedSheetInstances( projectName, sheetList );
 
    sheetList.AnnotatePowerSymbols();
 
    if( sheetList.AllSheetPageNumbersEmpty() )
        sheetList.SetInitialPageNumbers();
    else
        sheetList.RepairPageNumbers();
 
    // A schematic written by an older version can lose the junctions that Eeschema implies from
    // merged colinear wires, which shows up as connectivity errors.  The GUI editor repairs this on
    // load; the headless/CLI loader must do the same before connectivity is calculated.  It is
    // limited to pre-current files (the current version writes those junctions on save, so running
    // it on a current file could silently connect an intentional crossing) and to callers that
    // actually want connectivity.
    if( aCalculateConnectivity
        && schematic->RootScreen()->GetFileFormatVersionAtLoad() < SEXPR_SCHEMATIC_FILE_VERSION )
        schematic->FixupJunctionsAfterImport();
 
    schematic->ConnectionGraph()->Reset();
 
    TOOL_MANAGER* toolManager = new TOOL_MANAGER;
    toolManager->SetEnvironment( schematic.get(), nullptr, nullptr, Kiface().KifaceSettings(), nullptr );
 
    if( aCalculateConnectivity )
    {
        SCH_COMMIT dummyCommit( toolManager );
        schematic->CleanUpConnections( &dummyCommit, GLOBAL_CLEANUP );
        dummyCommit.Push( _( "Schematic Cleanup" ), SKIP_UNDO | SKIP_CONNECTIVITY | DELETE_REMOVED_ITEMS );
    }
 
    schematic->SetSheetNumberAndCount();
    schematic->RecomputeIntersheetRefs();
 
    for( SCH_SHEET_PATH& sheet : sheetList )
    {
        sheet.UpdateAllScreenReferences();
        sheet.LastScreen()->TestDanglingEnds( nullptr, nullptr );
    }
 
    if( aCalculateConnectivity )
        schematic->RebuildConnectivity();
 
    schematic->ResolveERCExclusionsPostUpdate();
 
    return schematic.release();
}