eeschema/files-io.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) 2013 Wayne Stambaugh <[email protected]>
 * Copyright (C) 2013-2023 CERN (www.cern.ch)
 * 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 <algorithm>
 
#include <confirm.h>
#include <common.h>
#include <connection_graph.h>
#include <dialog_migrate_buses.h>
#include <dialog_symbol_remap.h>
#include <dialog_import_choose_project.h>
#include <embedded_files.h>
#include <eeschema_settings.h>
#include <id.h>
#include <kiface_base.h>
#include <kiplatform/app.h>
#include <kiplatform/ui.h>
#include <libraries/legacy_cache_reconcile.h>
#include <libraries/legacy_symbol_library.h>
#include <libraries/symbol_library_adapter.h>
#include <local_history.h>
#include <lockfile.h>
#include <pgm_base.h>
#include <core/profile.h>
#include <project/project_file.h>
#include <project_rescue.h>
#include <project_sch.h>
#include <dialog_HTML_reporter_base.h>
#include <import_proj_properties.h>
#include <io/common/plugin_common_choose_project.h>
#include <reporter.h>
#include <richio.h>
#include <sch_footprint_field_reconciler.h>
#include <sch_bus_entry.h>
#include <sch_commit.h>
#include <sch_edit_frame.h>
#include <sch_draw_panel.h>
#include <sch_io/kicad_legacy/sch_io_kicad_legacy.h>
#include <sch_file_versions.h>
#include <sch_line.h>
#include <sch_sheet.h>
#include <sch_sheet_path.h>
#include <schematic.h>
#include <settings/settings_manager.h>
#include <sim/simulator_frame.h>
#include <symbol_import_reconciler.h>
#include <tool/actions.h>
#include <tool/tool_manager.h>
#include <tools/sch_editor_control.h>
#include <tools/sch_navigate_tool.h>
#include <trace_helpers.h>
#include <widgets/filedlg_import_non_kicad.h>
#include <widgets/kistatusbar.h>
#include <widgets/wx_infobar.h>
#include <wildcards_and_files_ext.h>
#include <local_history.h>
#include <drawing_sheet/ds_data_model.h>
#include <wx/app.h>
#include <wx/ffile.h>
#include <wx/filedlg.h>
#include <wx/log.h>
#include <wx/richmsgdlg.h>
#include <wx/stdpaths.h>
#include <tools/sch_inspection_tool.h>
#include <tools/sch_selection_tool.h>
#include <paths.h>
#include <wx_filename.h>  // For ::ResolvePossibleSymlinks
#include <widgets/wx_progress_reporters.h>
#include <widgets/wx_html_report_box.h>
 
#include <kiplatform/io.h>
 
#include "widgets/filedlg_hook_save_project.h"
#include "widgets/panel_remote_symbol.h"
#include "save_project_utils.h"
 
bool SCH_EDIT_FRAME::OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl )
{
    // ensure the splash screen does not obscure any dialog at startup
    Pgm().HideSplash();
 
    // implement the pseudo code from KIWAY_PLAYER.h:
    wxString msg;
 
    EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
 
    // This is for python:
    if( aFileSet.size() != 1 )
    {
        msg.Printf( "Eeschema:%s() takes only a single filename.", __WXFUNCTION__ );
        DisplayError( this, msg );
        return false;
    }
 
    wxString   fullFileName( aFileSet[0] );
    wxFileName wx_filename( fullFileName );
 
    // We insist on caller sending us an absolute path, if it does not, we say it's a bug.
    wxASSERT_MSG( wx_filename.IsAbsolute(), wxS( "Path is not absolute!" ) );
 
    if( !LockFile( fullFileName ) )
    {
        // If project-level lock override was already granted, silently override this file's lock
        if( Prj().IsLockOverrideGranted() )
        {
            m_file_checker->OverrideLock();
        }
        else
        {
            msg.Printf( _( "Schematic '%s' is already open by '%s' at '%s'." ), fullFileName,
                    m_file_checker->GetUsername(), m_file_checker->GetHostname() );
 
            if( !AskOverrideLock( this, msg ) )
                return false;
 
            m_file_checker->OverrideLock();
        }
    }
 
    if( !AskToSaveChanges() )
        return false;
 
#ifdef PROFILE
    PROF_TIMER openFiles( "OpenProjectFile" );
#endif
 
    wxFileName pro = fullFileName;
    pro.SetExt( FILEEXT::ProjectFileExtension );
 
    bool is_new = !wxFileName::IsFileReadable( fullFileName );
 
    // If its a non-existent schematic and caller thinks it exists
    if( is_new && !( aCtl & KICTL_CREATE ) )
    {
        // notify user that fullFileName does not exist, ask if user wants to create it.
        msg.Printf( _( "Schematic '%s' does not exist.  Do you wish to create it?" ), fullFileName );
 
        if( !IsOK( this, msg ) )
            return false;
    }
 
    wxCommandEvent e( EDA_EVT_SCHEMATIC_CHANGING );
    ProcessEventLocally( e );
 
    // unload current project file before loading new
    {
        ClearUndoRedoList();
        ClearRepeatItemsList();
        SetScreen( nullptr );
        m_toolManager->GetTool<SCH_INSPECTION_TOOL>()->Reset( TOOL_BASE::SUPERMODEL_RELOAD );
    }
 
    SetStatusText( wxEmptyString );
    m_infoBar->Dismiss();
 
    if( KISTATUSBAR* statusBar = dynamic_cast<KISTATUSBAR*>( GetStatusBar() ) )
        statusBar->ClearWarningMessages( "load" );
 
    WX_PROGRESS_REPORTER progressReporter( this, is_new ? _( "Create Schematic" ) : _( "Load Schematic" ), 1,
                                           PR_CAN_ABORT );
    WX_STRING_REPORTER loadReporter;
    LOAD_INFO_REPORTER_SCOPE loadReporterScope( &loadReporter );
 
    bool differentProject = pro.GetFullPath() != Prj().GetProjectFullName();
 
    // This is for handling standalone mode schematic changes
    if( differentProject )
    {
        if( !Prj().IsNullProject() )
        {
            SaveProjectLocalSettings();
            GetSettingsManager()->SaveProject();
        }
 
        // disconnect existing project from schematic before we unload the project
        Schematic().SetProject( nullptr );
        GetSettingsManager()->UnloadProject( &Prj(), false );
 
        GetSettingsManager()->LoadProject( pro.GetFullPath() );
 
        wxFileName legacyPro( pro );
        legacyPro.SetExt( FILEEXT::LegacyProjectFileExtension );
 
        // Do not allow saving a project if one doesn't exist.  This normally happens if we are
        // standalone and opening a schematic that has been moved from its project folder.
        if( !pro.Exists() && !legacyPro.Exists() && !( aCtl & KICTL_CREATE ) )
            Prj().SetReadOnly();
    }
 
    // Crash-recovery: when zip-format autosave is active, look for autosave files newer
    // than the saved schematic and offer to recover them before any sheet is loaded.
    if( !is_new )
        CheckForAutosaveFiles( wx_filename.GetPath(), { FILEEXT::KiCadSchematicFileExtension } );
 
    // Start a new schematic object now that we sorted out our project
    std::unique_ptr<SCHEMATIC> newSchematic = std::make_unique<SCHEMATIC>( &Prj() );
 
    SCH_IO_MGR::SCH_FILE_T schFileType = SCH_IO_MGR::GuessPluginTypeFromSchPath( fullFileName, aCtl );
 
    bool isNonKicadImport = schFileType != SCH_IO_MGR::SCH_KICAD
                            && schFileType != SCH_IO_MGR::SCH_LEGACY
                            && schFileType != SCH_IO_MGR::SCH_FILE_UNKNOWN;
 
    // If this is a recognised non-KiCad format, delegate to the import path.
    // Callers that pass KICTL_KICAD_ONLY (e.g. GUI open) won't reach
    // this branch because GuessPluginTypeFromSchPath already returns SCH_FILE_UNKNOWN
    // for these formats.
    if( isNonKicadImport )
    {
        progressReporter.Hide();
        return importFile( fullFileName, schFileType, nullptr );
    }
 
    if( schFileType == SCH_IO_MGR::SCH_LEGACY )
    {
        // Don't reload the symbol libraries if we are just launching Eeschema from KiCad again.
        // They are already saved in the kiface project object.
        if( differentProject || !Prj().GetElem( PROJECT::ELEM::LEGACY_SYMBOL_LIBS ) )
        {
            // load the libraries here, not in SCH_SCREEN::Draw() which is a context
            // that will not tolerate DisplayError() dialog since we're already in an
            // event handler in there.
            // And when a schematic file is loaded, we need these libs to initialize
            // some parameters (links to PART LIB, dangling ends ...)
            Prj().SetElem( PROJECT::ELEM::LEGACY_SYMBOL_LIBS, nullptr );
            PROJECT_SCH::LegacySchLibs( &Prj() );
        }
    }
    else
    {
        // No legacy symbol libraries including the cache are loaded with the new file format.
        Prj().SetElem( PROJECT::ELEM::LEGACY_SYMBOL_LIBS, nullptr );
    }
 
    wxFileName rfn( fullFileName );
    rfn.MakeRelativeTo( Prj().GetProjectPath() );
    LoadWindowState( rfn.GetFullPath() );
 
    KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Schematic file changes are unsaved" ) );
 
    if( Kiface().IsSingle() )
    {
        KIPLATFORM::APP::RegisterApplicationRestart( fullFileName );
    }
 
    if( is_new || schFileType == SCH_IO_MGR::SCH_FILE_T::SCH_FILE_UNKNOWN )
    {
        newSchematic->CreateDefaultScreens();
        SetSchematic( newSchematic.release() );
 
        // mark new, unsaved file as modified.
        GetScreen()->SetContentModified();
        GetScreen()->SetFileName( fullFileName );
 
        if( schFileType == SCH_IO_MGR::SCH_FILE_T::SCH_FILE_UNKNOWN )
        {
            if( aCtl & KICTL_KICAD_ONLY )
            {
                msg.Printf( _( "'%s' is not a KiCad schematic file.\n"
                               "Use File -> Import for non-KiCad schematic files." ), fullFileName );
            }
            else
            {
                // Even the non-KiCad plugin type didn't know
                msg.Printf( _( "'%s' is not a recognised schematic format." ), fullFileName );
            }
 
            progressReporter.Hide();
            DisplayErrorMessage( this, msg );
        }
    }
    else
    {
        SetScreen( nullptr );
 
        IO_RELEASER<SCH_IO> pi( SCH_IO_MGR::FindPlugin( schFileType ) );
 
        pi->SetProgressReporter( &progressReporter );
 
        bool failedLoad = false;
 
        try
        {
            {
                wxBusyCursor    busy;
                WINDOW_DISABLER raii( this );
 
                // Check if project file has top-level sheets defined
                PROJECT_FILE& projectFile = Prj().GetProjectFile();
                const std::vector<TOP_LEVEL_SHEET_INFO>& topLevelSheets = projectFile.GetTopLevelSheets();
 
                if( !topLevelSheets.empty() )
                {
                    std::vector<SCH_SHEET*> loadedSheets;
 
                    // Load each top-level sheet
                    for( const TOP_LEVEL_SHEET_INFO& sheetInfo : topLevelSheets )
                    {
                        wxFileName sheetFileName( Prj().GetProjectPath(), sheetInfo.filename );
 
                        // When loading legacy schematic files, ensure we are referencing the correct extension
                        if( schFileType == SCH_IO_MGR::SCH_LEGACY )
                            sheetFileName.SetExt( FILEEXT::LegacySchematicFileExtension );
 
                        wxString sheetPath = sheetFileName.GetFullPath();
 
                        if( !wxFileName::FileExists( sheetPath ) )
                        {
                            wxLogWarning( wxT( "Top-level sheet file not found: %s" ), sheetPath );
                            continue;
                        }
 
                        SCH_SHEET* sheet = pi->LoadSchematicFile( sheetPath, newSchematic.get() );
 
                        if( sheet )
                        {
                            // Preserve the UUID from the project file, unless it's niluuid which is
                            // just a placeholder meaning "use the UUID from the file"
                            if( sheetInfo.uuid != niluuid )
                            {
                                const_cast<KIID&>( sheet->m_Uuid ) = sheetInfo.uuid;
                            }
 
                            sheet->SetName( sheetInfo.name );
                            loadedSheets.push_back( sheet );
 
                            wxLogTrace( tracePathsAndFiles, wxS( "Loaded top-level sheet '%s' (UUID %s) from %s" ),
                                        sheet->GetName(), sheet->m_Uuid.AsString(), sheetPath );
                        }
                    }
 
                    if( !loadedSheets.empty() )
                    {
                        newSchematic->SetTopLevelSheets( loadedSheets );
                    }
                    else
                    {
                        wxLogTrace( tracePathsAndFiles,
                                    wxS( "Loaded multi-root schematic with no top-level sheets!" ) );
                        newSchematic->CreateDefaultScreens();
                    }
                }
                else
                {
                    // Legacy single-root format: Load the single root sheet
                    SCH_SHEET* rootSheet = pi->LoadSchematicFile( fullFileName, newSchematic.get() );
 
                    if( rootSheet )
                    {
                        newSchematic->SetTopLevelSheets( { rootSheet } );
 
                        // Make ${SHEETNAME} work on the root sheet until we properly support
                        // naming the root sheet
                        if( SCH_SHEET* topSheet = newSchematic->GetTopLevelSheet() )
                            topSheet->SetName( _( "Root" ) );
 
                        wxLogTrace( tracePathsAndFiles, wxS( "Loaded schematic with root sheet UUID %s" ),
                                    rootSheet->m_Uuid.AsString() );
                        wxLogTrace( traceSchCurrentSheet,
                                    wxS( "After loading: Current sheet path='%s', size=%zu, empty=%d" ),
                                    newSchematic->CurrentSheet().Path().AsString(),
                                    newSchematic->CurrentSheet().size(),
                                    newSchematic->CurrentSheet().empty() ? 1 : 0 );
                    }
                    else
                    {
                        newSchematic->CreateDefaultScreens();
                    }
 
                }
            }
 
            if( !pi->GetError().IsEmpty() )
            {
                DisplayErrorMessage( this, _( "The entire schematic could not be loaded.  Errors "
                                              "occurred attempting to load hierarchical sheets." ),
                                     pi->GetError() );
            }
        }
        catch( const FUTURE_FORMAT_ERROR& ffe )
        {
            newSchematic->CreateDefaultScreens();
            msg.Printf( _( "Error loading schematic '%s'." ), fullFileName );
            progressReporter.Hide();
            DisplayErrorMessage( this, msg, ffe.Problem() );
 
            failedLoad = true;
        }
        catch( const IO_ERROR& ioe )
        {
            newSchematic->CreateDefaultScreens();
            msg.Printf( _( "Error loading schematic '%s'." ), fullFileName );
            progressReporter.Hide();
            DisplayErrorMessage( this, msg, ioe.What() );
 
            failedLoad = true;
        }
        catch( const std::bad_alloc& )
        {
            newSchematic->CreateDefaultScreens();
            msg.Printf( _( "Memory exhausted loading schematic '%s'." ), fullFileName );
            progressReporter.Hide();
            DisplayErrorMessage( this, msg, wxEmptyString );
 
            failedLoad = true;
        }
 
        SetSchematic( newSchematic.release() );
 
        // This fixes a focus issue after the progress reporter is done on GTK.  It shouldn't
        // cause any issues on macOS and Windows.  If it does, it will have to be conditionally
        // compiled.
        Raise();
 
        if( failedLoad )
        {
            // Do not leave g_RootSheet == NULL because it is expected to be
            // a valid sheet. Therefore create a dummy empty root sheet and screen.
            CreateDefaultScreens();
            m_toolManager->RunAction( ACTIONS::zoomFitScreen );
 
            // Show any messages collected before the failure
            if( KISTATUSBAR* statusBar = dynamic_cast<KISTATUSBAR*>( GetStatusBar() ) )
                statusBar->AddWarningMessages( "load", loadReporter.GetMessages() );
 
            msg.Printf( _( "Failed to load '%s'." ), fullFileName );
            SetMsgPanel( wxEmptyString, msg );
 
            return false;
        }
 
        // Load project settings after schematic has been set up with the project link, since this will
        // update some of the needed schematic settings such as drawing defaults
        LoadProjectSettings();
 
        SCH_SHEET_LIST sheetList = Schematic().Hierarchy();
 
        bool repairedPageNumbers = false;
 
        if( sheetList.AllSheetPageNumbersEmpty() )
            sheetList.SetInitialPageNumbers();
        else
            repairedPageNumbers = sheetList.RepairPageNumbers();
 
        // It's possible the schematic parser fixed errors due to bugs, or that we reassigned
        // duplicate or blank sheet page numbers, so warn the user that the schematic has been
        // fixed (modified).
        if( sheetList.IsModified() || repairedPageNumbers )
        {
            DisplayInfoMessage( this, _( "An error was found when loading the schematic that has been "
                                         "automatically fixed.  Please save the schematic to repair the "
                                         "broken file or it may not be usable with other versions of "
                                         "KiCad." ) );
        }
 
        UpdateFileHistory( fullFileName );
 
        if( KISTATUSBAR* statusBar = dynamic_cast<KISTATUSBAR*>( GetStatusBar() ) )
            statusBar->AddWarningMessages( "load", loadReporter.GetMessages() );
 
        SCH_SCREENS schematic( Schematic().Root() );
 
        // LIB_ID checks and symbol rescue only apply to the legacy file formats.
        if( schFileType == SCH_IO_MGR::SCH_LEGACY )
        {
            // Convert any legacy bus-bus entries to just be bus wires
            for( SCH_SCREEN* screen = schematic.GetFirst(); screen; screen = schematic.GetNext() )
            {
                std::vector<SCH_ITEM*> deleted;
 
                for( SCH_ITEM* item : screen->Items() )
                {
                    if( item->Type() == SCH_BUS_BUS_ENTRY_T )
                    {
                        SCH_BUS_BUS_ENTRY* entry = static_cast<SCH_BUS_BUS_ENTRY*>( item );
                        std::unique_ptr<SCH_LINE> wire = std::make_unique<SCH_LINE>();
 
                        wire->SetLayer( LAYER_BUS );
                        wire->SetStartPoint( entry->GetPosition() );
                        wire->SetEndPoint( entry->GetEnd() );
 
                        screen->Append( wire.release() );
                        deleted.push_back( item );
                    }
                }
 
                for( SCH_ITEM* item : deleted )
                    screen->Remove( item );
            }
 
 
            // Convert old projects over to use symbol library table.
            if( schematic.HasNoFullyDefinedLibIds() )
            {
                DIALOG_SYMBOL_REMAP dlgRemap( this );
 
                dlgRemap.ShowQuasiModal();
            }
            else
            {
                // Double check to ensure no legacy library list entries have been
                // added to the project file symbol library list.
                wxString paths;
                wxArrayString libNames;
 
                LEGACY_SYMBOL_LIBS::GetLibNamesAndPaths( &Prj(), &paths, &libNames );
 
                if( !libNames.IsEmpty() )
                {
                    if( eeconfig()->m_Appearance.show_illegal_symbol_lib_dialog )
                    {
                        wxRichMessageDialog dlg( this,
                                                 _( "Illegal entry found in project file symbol library list." ),
                                                 _( "Project Load Warning" ),
                                                 wxOK | wxCENTER | wxICON_EXCLAMATION );
                        dlg.ShowDetailedText( _( "Symbol libraries defined in the project file symbol library "
                                                 "list are no longer supported and will be removed.\n\n"
                                                 "This may cause broken symbol library links under certain "
                                                 "conditions." ) );
                        dlg.ShowCheckBox( _( "Do not show this dialog again." ) );
                        dlg.ShowModal();
                        eeconfig()->m_Appearance.show_illegal_symbol_lib_dialog = !dlg.IsCheckBoxChecked();
                    }
 
                    libNames.Clear();
                    paths.Clear();
                    LEGACY_SYMBOL_LIBS::SetLibNamesAndPaths( &Prj(), paths, libNames );
                }
 
                // Check for cache file
                wxFileName cacheFn( fullFileName );
                cacheFn.SetName( cacheFn.GetName() + "-cache" );
                cacheFn.SetExt( FILEEXT::LegacySymbolLibFileExtension );
                bool cacheExists = cacheFn.FileExists();
 
                if( cacheExists )
                {
                    SYMBOL_LIBRARY_ADAPTER* adapter = PROJECT_SCH::SymbolLibAdapter( &Prj() );
                    std::optional<LIBRARY_TABLE*> table = adapter->ProjectTable();
 
                    if( table && *table )
                    {
                        wxString nickname = Prj().GetProjectName() + "-cache";
 
                        if( !(*table)->HasRow( nickname ) )
                        {
                            LIBRARY_TABLE_ROW& row = (*table)->InsertRow();
                            row.SetNickname( nickname );
                            row.SetURI( cacheFn.GetFullPath() );
                            row.SetType( SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY ) );
                            row.SetDescription( _( "Legacy project cache library" ) );
                            (*table)->Save();
                        }
 
                        std::vector<KI_ERROR> libErrors;
 
                        ReconcileLegacyCacheSymbols( *adapter, nickname, schematic, libErrors );
 
                        if( KISTATUSBAR* statusBar = dynamic_cast<KISTATUSBAR*>( GetStatusBar() ) )
                            statusBar->AddWarningMessages( "load", libErrors );
                    }
                }
 
                if( ( !cfg || !cfg->m_RescueNeverShow ) && !cacheExists )
                {
                    SCH_EDITOR_CONTROL* editor = m_toolManager->GetTool<SCH_EDITOR_CONTROL>();
                    editor->RescueSymbolLibTableProject( false );
                }
            }
 
            // Ensure there is only one legacy library loaded and that it is the cache library.
            LEGACY_SYMBOL_LIBS* legacyLibs = PROJECT_SCH::LegacySchLibs( &Schematic().Project() );
 
            if( legacyLibs->GetLibraryCount() == 0 )
            {
                wxFileName cacheFn = pro;
 
                wxLogTrace( traceAutoSave, "[SetName dbg] cacheFn BEFORE path='%s' name='%s' full='%s' arg='%s'",
                            cacheFn.GetPath(), cacheFn.GetName(), cacheFn.GetFullPath(), cacheFn.GetName() + "-cache" );
                cacheFn.SetName( cacheFn.GetName() + "-cache" );
                wxLogTrace( traceAutoSave, "[SetName dbg] cacheFn AFTER  path='%s' name='%s' full='%s'",
                            cacheFn.GetPath(), cacheFn.GetName(), cacheFn.GetFullPath() );
                cacheFn.SetExt( FILEEXT::LegacySymbolLibFileExtension );
 
                msg.Printf( _( "The project symbol library cache file '%s' was not found." ), cacheFn.GetFullName() );
 
                KICAD_MESSAGE_DIALOG dlg( this, msg, _( "Warning" ), wxOK | wxCANCEL | wxICON_EXCLAMATION | wxCENTER );
                dlg.SetExtendedMessage( _( "This can result in a broken schematic under certain conditions.  If the "
                                           "schematic does not have any missing symbols upon opening, save it "
                                           "immediately before making any changes to prevent data loss.  If there "
                                           "are missing symbols, either manual recovery of the schematic or "
                                           "recovery of the symbol cache library file and reloading the schematic is "
                                           "required." ) );
                dlg.SetOKCancelLabels( KICAD_MESSAGE_DIALOG::ButtonLabel( _( "Load Without Cache File" ) ),
                                       KICAD_MESSAGE_DIALOG::ButtonLabel( _( "Abort" ) ) );
 
                if( dlg.ShowModal() == wxID_CANCEL )
                {
                    Schematic().Reset();
                    CreateDefaultScreens();
                    return false;
                }
            }
 
            // Update all symbol library links for all sheets.
            schematic.UpdateSymbolLinks( &loadReporter );
 
            m_infoBar->RemoveAllButtons();
            m_infoBar->AddCloseButton();
            m_infoBar->ShowMessage( _( "This file was created by an older version of KiCad. "
                                       "It will be converted to the new format when saved." ),
                                    wxICON_WARNING, WX_INFOBAR::MESSAGE_TYPE::OUTDATED_SAVE );
 
            // Legacy schematic can have duplicate time stamps so fix that before converting
            // to the s-expression format.
            schematic.ReplaceDuplicateTimeStamps();
 
            for( SCH_SCREEN* screen = schematic.GetFirst(); screen; screen = schematic.GetNext() )
                screen->FixLegacyPowerSymbolMismatches();
 
            // Allow the schematic to be saved to new file format without making any edits.
            OnModify();
        }
        else  // S-expression schematic.
        {
            SCH_SCREEN* first_screen = schematic.GetFirst();
 
            // Skip the first screen as it is a virtual root with no version info.
            if( first_screen && first_screen->GetFileFormatVersionAtLoad() == 0 )
                first_screen = schematic.GetNext();
 
            if( first_screen && first_screen->GetFileFormatVersionAtLoad() < SEXPR_SCHEMATIC_FILE_VERSION )
            {
                m_infoBar->RemoveAllButtons();
                m_infoBar->AddCloseButton();
                m_infoBar->ShowMessage( _( "This file was created by an older version of KiCad. "
                                           "It will be converted to the new format when saved." ),
                                        wxICON_WARNING, WX_INFOBAR::MESSAGE_TYPE::OUTDATED_SAVE );
            }
 
            for( SCH_SCREEN* screen = schematic.GetFirst(); screen; screen = schematic.GetNext() )
                screen->UpdateLocalLibSymbolLinks();
 
            SCH_SCREEN* rootScreen = Schematic().RootScreen();
 
            // Restore all of the loaded symbol and sheet instances from the root sheet.
            if( rootScreen && rootScreen->GetFileFormatVersionAtLoad() < 20221002 )
                sheetList.UpdateSymbolInstanceData( rootScreen->GetSymbolInstances() );
 
            if( rootScreen && rootScreen->GetFileFormatVersionAtLoad() < 20221110 )
                sheetList.UpdateSheetInstanceData( rootScreen->GetSheetInstances());
 
            if( rootScreen && rootScreen->GetFileFormatVersionAtLoad() < 20230221 )
                for( SCH_SCREEN* screen = schematic.GetFirst(); screen;
                     screen = schematic.GetNext() )
                    screen->FixLegacyPowerSymbolMismatches();
 
            for( SCH_SCREEN* screen = schematic.GetFirst(); screen; screen = schematic.GetNext() )
                screen->MigrateSimModels();
 
            Schematic().LoadVariants();
            UpdateVariantSelectionCtrl( Schematic().GetVariantNamesForUI() );
        }
 
        // After the schematic is successfully loaded, we load the drawing sheet.
        // This allows us to use the drawing sheet embedded in the schematic (if any)
        // instead of the default one.
        LoadDrawingSheet();
 
        wxLogTrace( traceSchCurrentSheet, "Before CheckForMissingSymbolInstances: Current sheet path='%s', size=%zu",
                    GetCurrentSheet().Path().AsString(), GetCurrentSheet().size() );
 
        // 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( Prj().GetProjectName() );
 
        schematic.PruneOrphanedSymbolInstances( Prj().GetProjectName(), sheetList );
        schematic.PruneOrphanedSheetInstances( Prj().GetProjectName(), sheetList );
 
        Schematic().ConnectionGraph()->Reset();
 
        SetScreen( GetCurrentSheet().LastScreen() );
 
        // Repaired page numbers changed in-memory sheet instances; flag the schematic so the
        // fixed numbering can be saved instead of silently reverting on the next load.
        if( repairedPageNumbers )
            OnModify();
 
        wxLogTrace( traceSchCurrentSheet, "After SetScreen: Current sheet path='%s', size=%zu",
                    GetCurrentSheet().Path().AsString(), GetCurrentSheet().size() );
 
        // Older files can omit implied junctions. Repair them before publishing connectivity;
        // repairing current files could instead connect an intentional wire crossing.
        const bool nativeNeedsFixup = schFileType == SCH_IO_MGR::SCH_KICAD
                                && Schematic().RootScreen()->GetFileFormatVersionAtLoad()
                                           < SEXPR_SCHEMATIC_FILE_VERSION;
 
        if( schFileType == SCH_IO_MGR::SCH_LEGACY || nativeNeedsFixup )
            Schematic().FixupJunctionsAfterImport();
 
        SCH_COMMIT dummy( this );
 
        progressReporter.Report( _( "Updating connections..." ) );
        progressReporter.KeepRefreshing();
 
        RecalculateConnections( &dummy, GLOBAL_CLEANUP, &progressReporter );
        dummy.Push( _( "Schematic Cleanup" ), SKIP_UNDO | SKIP_SET_DIRTY | SKIP_CONNECTIVITY | DELETE_REMOVED_ITEMS );
 
        // Migrate conflicting bus definitions, but only for files old enough to store them.
        // The connection graph must be rebuilt first so GetBusesNeedingMigration() can see the
        // conflicting subgraphs; the earlier Reset() clears them.
        SCH_SCREEN* schRootScreen = Schematic().RootScreen();
        int         schFileVersion = schRootScreen ? schRootScreen->GetFileFormatVersionAtLoad() : 0;
 
        if( DIALOG_MIGRATE_BUSES::ShouldPrompt(
                    schFileVersion, Schematic().ConnectionGraph()->GetBusesNeedingMigration().size() ) )
        {
            progressReporter.Hide();
 
            // The rebuild below frees the subgraphs the dialog caches, and a progress update can
            // dispatch queued UI events into its still-bound handlers, so destroy the dialog first.
            {
                DIALOG_MIGRATE_BUSES dlg( this );
                dlg.ShowQuasiModal();
            }
 
            OnModify();
            progressReporter.Show();
 
            // Relabeling the conflicting buses changes connectivity, so rebuild it.
            RecalculateConnections( &dummy, GLOBAL_CLEANUP, &progressReporter );
            dummy.Push( _( "Schematic Cleanup" ),
                        SKIP_UNDO | SKIP_SET_DIRTY | SKIP_CONNECTIVITY | DELETE_REMOVED_ITEMS );
        }
 
        if( schematic.HasSymbolFieldNamesWithWhiteSpace() )
        {
            m_infoBar->QueueShowMessage( _( "This schematic contains symbols that have leading "
                                            "and/or trailing white space field names." ),
                                         wxICON_WARNING );
        }
    }
 
    // Load any exclusions from the project file
    Schematic().ResolveERCExclusionsPostUpdate();
 
    initScreenZoom();
    SetSheetNumberAndCount();
 
    RecomputeIntersheetRefs();
    GetCurrentSheet().UpdateAllScreenReferences();
 
    SyncView();
    GetScreen()->ClearDrawingState();
 
    TestDanglingEnds();
 
    UpdateHierarchyNavigator( false, true );
    CallAfter(
            [this]()
            {
                if( m_netNavigator && m_netNavigatorStale )
                    RefreshNetNavigator();
            } );
 
    wxCommandEvent changedEvt( EDA_EVT_SCHEMATIC_CHANGED );
    ProcessEventLocally( changedEvt );
 
    if( !differentProject )
    {
        // If we didn't reload the project, we still need to call ProjectChanged() to ensure
        // frame-specific initialization happens (like registering the autosave saver).
        // When running under the project manager, KIWAY::ProjectChanged() was called before
        // this frame existed, so we need to call our own ProjectChanged() now.
        ProjectChanged();
    }
 
    for( wxEvtHandler* listener : m_schematicChangeListeners )
    {
        wxCHECK2( listener, continue );
 
        // Use the windows variant when handling event messages in case there is any special
        // event handler pre and/or post processing specific to windows.
        wxWindow* win = dynamic_cast<wxWindow*>( listener );
 
        if( win )
            win->HandleWindowEvent( e );
        else
            listener->SafelyProcessEvent( e );
    }
 
    updateTitle();
    m_toolManager->GetTool<SCH_NAVIGATE_TOOL>()->ResetHistory();
 
    wxFileName fn = Prj().AbsolutePath( GetScreen()->GetFileName() );
 
    if( fn.FileExists() && !fn.IsFileWritable() )
    {
        m_infoBar->RemoveAllButtons();
        m_infoBar->AddCloseButton();
        m_infoBar->ShowMessage( _( "Schematic is read only." ), wxICON_WARNING,
                                WX_INFOBAR::MESSAGE_TYPE::OUTDATED_SAVE );
    }
 
#ifdef PROFILE
    openFiles.Show();
#endif
    // Ensure all items are redrawn (especially the drawing-sheet items):
    if( GetCanvas() )
        GetCanvas()->DisplaySheet( GetCurrentSheet().LastScreen() );
 
    // Trigger a library load to handle any project-specific libraries
    CallAfter(
            [&]()
            {
                KIFACE *schface = Kiway().KiFACE( KIWAY::FACE_SCH );
                schface->PreloadLibraries( &Kiway() );
 
                Pgm().PreloadDesignBlockLibraries( &Kiway() );
            } );
 
    m_remoteSymbolPane->BindWebViewLoaded();
 
    return true;
}
 
 
void SCH_EDIT_FRAME::OnImportProject()
{
    if( Schematic().RootScreen() && !Schematic().RootScreen()->Items().empty() )
    {
        wxString msg = _( "This operation replaces the contents of the current schematic, "
                          "which will be permanently lost.\n\n"
                          "Do you want to proceed?" );
 
        if( !IsOK( this, msg ) )
            return;
    }
 
    // Set the project location if none is set or if we are running in standalone mode
    bool     setProject = Prj().GetProjectFullName().IsEmpty() || Kiface().IsSingle();
    wxString path = wxPathOnly( Prj().GetProjectFullName() );
 
    wxString fileFiltersStr;
    wxString allWildcardsStr;
 
    for( const SCH_IO_MGR::SCH_FILE_T& fileType : SCH_IO_MGR::SCH_FILE_T_vector )
    {
        if( fileType == SCH_IO_MGR::SCH_KICAD || fileType == SCH_IO_MGR::SCH_LEGACY )
            continue; // this is "Import non-KiCad schematic"
 
        IO_RELEASER<SCH_IO> pi( SCH_IO_MGR::FindPlugin( fileType ) );
 
        if( !pi )
            continue;
 
        const IO_BASE::IO_FILE_DESC& desc = pi->GetSchematicFileDesc();
 
        if( desc.m_FileExtensions.empty() || !desc.m_CanRead )
            continue;
 
        if( !fileFiltersStr.IsEmpty() )
            fileFiltersStr += wxChar( '|' );
 
        fileFiltersStr += desc.FileFilter();
 
        for( const std::string& ext : desc.m_FileExtensions )
            allWildcardsStr << wxS( "*." ) << formatWildcardExt( ext ) << wxS( ";" );
    }
 
    fileFiltersStr = _( "All supported formats" ) + wxS( "|" ) + allWildcardsStr + wxS( "|" ) + fileFiltersStr;
 
    wxFileDialog dlg( this, _( "Import Schematic" ), path, wxEmptyString, fileFiltersStr,
                      wxFD_OPEN | wxFD_FILE_MUST_EXIST );
 
    FILEDLG_IMPORT_NON_KICAD importOptions( eeconfig()->m_System.show_import_issues );
    dlg.SetCustomizeHook( importOptions );
 
    KIPLATFORM::UI::AllowNetworkFileSystems( &dlg );
 
    if( dlg.ShowModal() == wxID_CANCEL )
        return;
 
    eeconfig()->m_System.show_import_issues = importOptions.GetShowIssues();
 
    // Don't leave dangling pointers to previously-opened document.
    m_toolManager->GetTool<SCH_SELECTION_TOOL>()->ClearSelection();
    ClearUndoRedoList();
    ClearRepeatItemsList();
 
    if( setProject )
    {
        Schematic().SetProject( nullptr );
        GetSettingsManager()->UnloadProject( &Prj(), false );
 
        // Clear view before destroying schematic as repaints depend on schematic being valid
        SetScreen( nullptr );
 
        Schematic().Reset();
 
        wxFileName projectFn( dlg.GetPath() );
        projectFn.SetExt( FILEEXT::ProjectFileExtension );
        GetSettingsManager()->LoadProject( projectFn.GetFullPath() );
    }
 
    wxFileName fn = dlg.GetPath();
 
    if( !fn.IsFileReadable() )
    {
        wxLogError( _( "Insufficient permissions to read file '%s'." ), fn.GetFullPath() );
        return;
    }
 
    SCH_IO_MGR::SCH_FILE_T pluginType = SCH_IO_MGR::SCH_FILE_T::SCH_FILE_UNKNOWN;
 
    for( const SCH_IO_MGR::SCH_FILE_T& fileType : SCH_IO_MGR::SCH_FILE_T_vector )
    {
        IO_RELEASER<SCH_IO> pi( SCH_IO_MGR::FindPlugin( fileType ) );
 
        if( !pi )
            continue;
 
        if( pi->CanReadSchematicFile( fn.GetFullPath() ) )
        {
            pluginType = fileType;
            break;
        }
    }
 
    if( pluginType == SCH_IO_MGR::SCH_FILE_T::SCH_FILE_UNKNOWN )
    {
        wxLogError( _( "No loader can read the specified file: '%s'." ), fn.GetFullPath() );
        CreateDefaultScreens();
        SetScreen( Schematic().RootScreen() );
        return;
    }
 
    importFile( dlg.GetPath(), pluginType );
 
    RefreshCanvas();
}
 
 
bool SCH_EDIT_FRAME::saveSchematicFile( SCH_SHEET* aSheet, const wxString& aSavePath, bool isSaveAs )
{
    wxString msg;
    wxFileName schematicFileName;
    wxFileName oldFileName;
    bool success;
 
    SCH_SCREEN* screen = aSheet->GetScreen();
 
    wxCHECK( screen, false );
 
    // Cannot save to nowhere
    if( aSavePath.IsEmpty() )
        return false;
 
    // Construct the name of the file to be saved
    schematicFileName = Prj().AbsolutePath( aSavePath );
    oldFileName = schematicFileName;
 
    // Write through symlinks, don't replace them
    WX_FILENAME::ResolvePossibleSymlinks( schematicFileName );
 
    if( !schematicFileName.DirExists() )
    {
        if( !wxMkdir( schematicFileName.GetPath() ) )
        {
            msg.Printf( _( "Error saving schematic file '%s'.\n%s" ),
                        schematicFileName.GetFullPath(),
                        "Could not create directory: %s" + schematicFileName.GetPath() );
            DisplayError( this, msg );
 
            return false;
        }
    }
 
    if( !IsWritable( schematicFileName ) )
        return false;
 
    wxFileName projectFile( schematicFileName );
 
    projectFile.SetExt( FILEEXT::ProjectFileExtension );
 
    if( projectFile.FileExists() )
    {
        // Save various ERC settings, such as violation severities (which may have been edited
        // via the ERC dialog as well as the Schematic Setup dialog), ERC exclusions, etc.
        saveProjectSettings();
    }
 
    // Save
    wxLogTrace( traceAutoSave, wxS( "Saving file " ) + schematicFileName.GetFullPath() );
 
    if( m_infoBar->GetMessageType() == WX_INFOBAR::MESSAGE_TYPE::OUTDATED_SAVE )
        m_infoBar->Dismiss();
 
    SCH_IO_MGR::SCH_FILE_T pluginType = SCH_IO_MGR::GuessPluginTypeFromSchPath( schematicFileName.GetFullPath() );
 
    if( pluginType == SCH_IO_MGR::SCH_FILE_UNKNOWN )
        pluginType = SCH_IO_MGR::SCH_KICAD;
 
    IO_RELEASER<SCH_IO> pi( SCH_IO_MGR::FindPlugin( pluginType ) );
 
    // On Windows, ensure the target file is writeable by clearing problematic attributes like
    // hidden or read-only. This can happen when files are synced via cloud services.
    if( schematicFileName.FileExists() )
        KIPLATFORM::IO::MakeWriteable( schematicFileName.GetFullPath() );
 
    try
    {
        pi->SaveSchematicFile( schematicFileName.GetFullPath(), aSheet, &Schematic() );
        success = true;
    }
    catch( const IO_ERROR& ioe )
    {
        msg.Printf( _( "Error saving schematic file '%s'.\n%s" ),
                    schematicFileName.GetFullPath(),
                    ioe.What() );
        DisplayError( this, msg );
 
        success = false;
    }
 
    if( success )
    {
        if( !isSaveAs )
            screen->SetContentModified( false );
 
        msg.Printf( _( "File '%s' saved." ),  screen->GetFileName() );
        SetStatusText( msg, 0 );
    }
 
    return success;
}
 
 
bool PrepareSaveAsFiles( SCHEMATIC& aSchematic, SCH_SCREENS& aScreens, const wxFileName& aOldRoot,
                         const wxFileName& aNewRoot, bool aSaveCopy, bool aCopySubsheets, bool aIncludeExternSheets,
                         std::unordered_map<SCH_SCREEN*, wxString>& aFilenameMap, wxString& aErrorMsg )
{
    SCH_SCREEN* screen;
 
    for( size_t i = 0; i < aScreens.GetCount(); i++ )
    {
        screen = aScreens.GetScreen( i );
 
        wxCHECK2( screen, continue );
 
        if( screen == aSchematic.RootScreen() )
            continue;
 
        // The virtual root's screen only holds the top-level sheets and has no file of its own
        // A destination here would be a nameless path that callers turn into a stray ".kicad_sch"
        if( screen == aSchematic.Root().GetScreen() )
            continue;
 
        wxFileName src = screen->GetFileName();
 
        if( !src.IsAbsolute() )
            src.MakeAbsolute( aOldRoot.GetPath() );
 
        bool internalSheet = src.GetPath().StartsWith( aOldRoot.GetPath() );
 
        if( aCopySubsheets && ( internalSheet || aIncludeExternSheets ) )
        {
            wxFileName dest = src;
 
            if( internalSheet && dest.MakeRelativeTo( aOldRoot.GetPath() ) )
                dest.MakeAbsolute( aNewRoot.GetPath() );
            else
                dest.Assign( aNewRoot.GetPath(), dest.GetFullName() );
 
            wxLogTrace( tracePathsAndFiles, wxS( "Moving schematic from '%s' to '%s'." ),
                        screen->GetFileName(), dest.GetFullPath() );
 
            if( !dest.DirExists() && !dest.Mkdir() )
            {
                aErrorMsg.Printf( _( "Folder '%s' could not be created.\n\n"
                                     "Make sure you have write permissions and try again." ),
                                 dest.GetPath() );
                return false;
            }
 
            if( aSaveCopy )
                aFilenameMap[screen] = dest.GetFullPath();
            else
                screen->SetFileName( dest.GetFullPath() );
        }
        else
        {
            if( aSaveCopy )
                aFilenameMap[screen] = wxString();
 
            screen->SetFileName( src.GetFullPath() );
        }
    }
 
    for( SCH_SHEET_PATH& sheet : aSchematic.Hierarchy() )
    {
        if( !sheet.Last()->IsTopLevelSheet() )
            sheet.MakeFilePathRelativeToParentSheet();
    }
 
    return true;
}
 
bool SCH_EDIT_FRAME::SaveProject( bool aSaveAs )
{
    wxString msg;
    SCH_SCREEN* screen;
    SCH_SCREENS screens( Schematic().Root() );
    bool        saveCopy          = aSaveAs && !Kiface().IsSingle();
    bool        success           = true;
    bool        updateFileHistory = false;
    bool        createNewProject  = false;
    bool        copySubsheets     = false;
    bool        includeExternSheets = false;
 
    // I want to see it in the debugger, show me the string!  Can't do that with wxFileName.
    wxString    fileName = Prj().AbsolutePath( Schematic().Root().GetFileName() );
    wxFileName  fn = fileName;
 
    // Path to save each screen to: will be the stored filename by default, but is overwritten by
    // a Save As Copy operation.
    std::unordered_map<SCH_SCREEN*, wxString> filenameMap;
 
    // Handle "Save As" and saving a new project/schematic for the first time in standalone
    if( Prj().IsNullProject() || aSaveAs )
    {
        // Null project should only be possible in standalone mode.
        wxCHECK( Kiface().IsSingle() || aSaveAs, false );
 
        wxFileName newFileName;
        wxFileName savePath( Prj().GetProjectFullName() );
 
        if( !savePath.IsOk() || !savePath.IsDirWritable() )
        {
            savePath = GetMruPath();
 
            if( !savePath.IsOk() || !savePath.IsDirWritable() )
                savePath = PATHS::GetDefaultUserProjectsPath();
        }
 
        if( savePath.HasExt() )
            savePath.SetExt( FILEEXT::KiCadSchematicFileExtension );
        else
            savePath.SetName( wxEmptyString );
 
        wxFileDialog dlg( this, _( "Schematic Files" ), savePath.GetPath(), savePath.GetFullName(),
                          FILEEXT::KiCadSchematicFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
 
        FILEDLG_HOOK_SAVE_PROJECT newProjectHook;
 
        // Add a "Create a project" checkbox in standalone mode and one isn't loaded
        if( Kiface().IsSingle() || aSaveAs )
        {
            dlg.SetCustomizeHook( newProjectHook );
        }
 
        KIPLATFORM::UI::AllowNetworkFileSystems( &dlg );
 
        if( dlg.ShowModal() == wxID_CANCEL )
            return false;
 
        newFileName = EnsureFileExtension( dlg.GetPath(), FILEEXT::KiCadSchematicFileExtension );
 
        if( ( !newFileName.DirExists() && !newFileName.Mkdir() )
            || !newFileName.IsDirWritable() )
        {
            msg.Printf( _( "Folder '%s' could not be created.\n\n"
                           "Make sure you have write permissions and try again." ),
                        newFileName.GetPath() );
 
            KICAD_MESSAGE_DIALOG dlgBadPath( this, msg, _( "Error" ), wxOK | wxICON_EXCLAMATION | wxCENTER );
 
            dlgBadPath.ShowModal();
            return false;
        }
 
        if( newProjectHook.IsAttachedToDialog() )
        {
            createNewProject = newProjectHook.GetCreateNewProject();
            copySubsheets = newProjectHook.GetCopySubsheets();
            includeExternSheets = newProjectHook.GetIncludeExternSheets();
        }
 
        if( !saveCopy )
        {
            Schematic().Root().SetFileName( newFileName.GetFullName() );
            Schematic().RootScreen()->SetFileName( newFileName.GetFullPath() );
            updateFileHistory = true;
        }
        else
        {
            filenameMap[Schematic().RootScreen()] = newFileName.GetFullPath();
        }
 
        if( !PrepareSaveAsFiles( Schematic(), screens, fn, newFileName, saveCopy, copySubsheets, includeExternSheets,
                                 filenameMap, msg ) )
        {
            KICAD_MESSAGE_DIALOG dlgBadFilePath( this, msg, _( "Error" ), wxOK | wxICON_EXCLAMATION | wxCENTER );
 
            dlgBadFilePath.ShowModal();
            return false;
        }
    }
    else if( !fn.FileExists() )
    {
        // File doesn't exist yet; true if we just imported something
        updateFileHistory = true;
    }
    else if( screens.GetFirst() && screens.GetFirst()->GetFileFormatVersionAtLoad() < SEXPR_SCHEMATIC_FILE_VERSION )
    {
        // Allow the user to save un-edited files in new format
    }
    else if( !IsContentModified() )
    {
        return true;
    }
 
    if( filenameMap.empty() || !saveCopy )
    {
        for( size_t i = 0; i < screens.GetCount(); i++ )
            filenameMap[screens.GetScreen( i )] = screens.GetScreen( i )->GetFileName();
    }
 
    // Warn user on potential file overwrite.  This can happen on shared sheets.
    wxArrayString overwrittenFiles;
    wxArrayString lockedFiles;
 
    for( size_t i = 0; i < screens.GetCount(); i++ )
    {
        screen = screens.GetScreen( i );
 
        wxCHECK2( screen, continue );
 
        // Convert legacy schematics file name extensions for the new format.
        wxFileName tmpFn = filenameMap[screen];
 
        if( !tmpFn.IsOk() )
            continue;
 
        if( tmpFn.FileExists() && !tmpFn.IsFileWritable() )
            lockedFiles.Add( tmpFn.GetFullPath() );
 
        if( tmpFn.GetExt() == FILEEXT::KiCadSchematicFileExtension )
            continue;
 
        tmpFn.SetExt( FILEEXT::KiCadSchematicFileExtension );
 
        if( tmpFn.FileExists() )
            overwrittenFiles.Add( tmpFn.GetFullPath() );
    }
 
    if( !lockedFiles.IsEmpty() )
    {
        for( const wxString& lockedFile : lockedFiles )
        {
            if( msg.IsEmpty() )
                msg = lockedFile;
            else
                msg += "\n" + lockedFile;
        }
 
        wxRichMessageDialog dlg( this, wxString::Format( _( "Failed to save %s." ), Schematic().Root().GetFileName() ),
                                 _( "Locked File Warning" ), wxOK | wxICON_WARNING | wxCENTER );
        dlg.SetExtendedMessage( _( "You do not have write permissions to:\n\n" ) + msg );
 
        dlg.ShowModal();
        return false;
    }
 
    if( !overwrittenFiles.IsEmpty() )
    {
        for( const wxString& overwrittenFile : overwrittenFiles )
        {
            if( msg.IsEmpty() )
                msg = overwrittenFile;
            else
                msg += "\n" + overwrittenFile;
        }
 
        wxRichMessageDialog dlg( this, _( "Saving will overwrite existing files." ), _( "Save Warning" ),
                                 wxOK | wxCANCEL | wxCANCEL_DEFAULT | wxCENTER | wxICON_EXCLAMATION );
        dlg.ShowDetailedText( _( "The following files will be overwritten:\n\n" ) + msg );
        dlg.SetOKCancelLabels( KICAD_MESSAGE_DIALOG::ButtonLabel( _( "Overwrite Files" ) ),
                               KICAD_MESSAGE_DIALOG::ButtonLabel( _( "Abort Project Save" ) ) );
 
        if( dlg.ShowModal() == wxID_CANCEL )
            return false;
    }
 
    screens.BuildClientSheetPathList();
 
    std::vector<wxString> savedSheetPaths;
 
    for( size_t i = 0; i < screens.GetCount(); i++ )
    {
        screen = screens.GetScreen( i );
 
        wxCHECK2( screen, continue );
 
        // Convert legacy schematics file name extensions for the new format.
        wxFileName tmpFn = filenameMap[screen];
 
        if( tmpFn.IsOk() && tmpFn.GetExt() != FILEEXT::KiCadSchematicFileExtension )
        {
            updateFileHistory = true;
            tmpFn.SetExt( FILEEXT::KiCadSchematicFileExtension );
 
            for( EDA_ITEM* item : screen->Items().OfType( SCH_SHEET_T ) )
            {
                SCH_SHEET* sheet = static_cast<SCH_SHEET*>( item );
                wxFileName sheetFileName = sheet->GetFileName();
 
                if( !sheetFileName.IsOk() || sheetFileName.GetExt() == FILEEXT::KiCadSchematicFileExtension )
                    continue;
 
                sheetFileName.SetExt( FILEEXT::KiCadSchematicFileExtension );
                sheet->SetFileName( sheetFileName.GetFullPath() );
                UpdateItem( sheet );
            }
 
            filenameMap[screen] = tmpFn.GetFullPath();
 
            if( !saveCopy )
                screen->SetFileName( tmpFn.GetFullPath() );
        }
 
        // Do not save sheet symbols with no valid filename set
        if( !tmpFn.IsOk() )
            continue;
 
        std::vector<SCH_SHEET_PATH>& sheets = screen->GetClientSheetPaths();
 
        if( sheets.size() == 1 )
            screen->SetVirtualPageNumber( 1 );
        else
            screen->SetVirtualPageNumber( 0 );  // multiple uses; no way to store the real sheet #
 
        // This is a new schematic file so make sure it has a unique ID.
        if( !saveCopy && tmpFn.GetFullPath() != screen->GetFileName() )
            screen->AssignNewUuid();
 
        bool savedThisSheet = saveSchematicFile( screens.GetSheet( i ), tmpFn.GetFullPath(), false );
 
        if( savedThisSheet )
            savedSheetPaths.push_back( tmpFn.GetFullPath() );
 
        success &= savedThisSheet;
    }
 
    if( success )
    {
        if( m_autoSaveTimer )
            m_autoSaveTimer->Stop();
 
        m_autoSavePending = false;
        m_autoSaveRequired = false;
 
        LockFile( Schematic().RootScreen()->GetFileName() );
    }
 
    if( updateFileHistory )
        UpdateFileHistory( Schematic().RootScreen()->GetFileName() );
 
    // Save the sheet name map to the project file
    std::vector<FILE_INFO_PAIR>& sheets = Prj().GetProjectFile().GetSheets();
    sheets.clear();
 
    for( SCH_SHEET_PATH& sheetPath : Schematic().Hierarchy() )
    {
        SCH_SHEET* sheet = sheetPath.Last();
 
        wxCHECK2( sheet, continue );
 
        // Do not save the virtual root sheet
        if( !sheet->IsVirtualRootSheet() )
            sheets.emplace_back( std::make_pair( sheet->m_Uuid, sheet->GetName() ) );
    }
 
    wxASSERT( filenameMap.count( Schematic().RootScreen() ) );
    wxFileName projectPath( filenameMap.at( Schematic().RootScreen() ) );
    projectPath.SetExt( FILEEXT::ProjectFileExtension );
 
    if( Prj().IsNullProject() || ( aSaveAs && !saveCopy ) )
    {
        Prj().SetReadOnly( !createNewProject );
        GetSettingsManager()->SaveProjectAs( projectPath.GetFullPath() );
    }
    else if( saveCopy && createNewProject )
    {
        GetSettingsManager()->SaveProjectCopy( projectPath.GetFullPath() );
    }
    else
    {
        SaveProjectLocalSettings();
        saveProjectSettings();
    }
 
    // Record a full project snapshot so related files (symbols, libs, sheets) are captured.
    // Skip when running standalone without a project loaded - the save path can land
    // anywhere on the filesystem and there is no project context for a snapshot.
    if( success && !Prj().IsNullProject() )
    {
        Kiway().LocalHistory().RunRegisteredSaversAndCommit( Prj().GetProjectPath(), wxS( "SCH Save" ), wxS( "sch" ) );
 
        // Drop the autosave files for the sheets we just persisted.  Scope to those
        // sources so other dirty sheets (and any open PCB) keep their autosaves until
        // they are saved themselves; otherwise a Save All across editors would lose
        // recovery data for files this save did not write.
        // RunRegisteredSaversAndCommit above is a no-op when format is ZIP, and
        // RemoveAutosaveFiles is conversely a no-op in INCREMENTAL mode.
        Kiway().LocalHistory().RemoveAutosaveFiles( Prj().GetProjectPath(), savedSheetPaths );
    }
 
    WX_STRING_REPORTER backupReporter;
 
    if( !Kiface().IsSingle() )
        GetSettingsManager()->TriggerBackupIfNeeded( backupReporter );
 
    // Restore the virtual page numbers that were modified during save. When saving, screens are
    // assigned page number 1 (single use) or 0 (multiple uses) for serialization purposes.
    // We restore all screens here, not just the current one, because other code paths (e.g.
    // ERC tree model, temporary sheet switches) may read any screen's virtual page number.
    for( const SCH_SHEET_PATH& sheet : Schematic().Hierarchy() )
        sheet.LastScreen()->SetVirtualPageNumber( sheet.GetVirtualPageNumber() );
 
    SetSheetNumberAndCount();
 
    if( GetCanvas() && GetCanvas()->GetView() )
    {
        GetCanvas()->GetView()->RefreshDrawingSheetPageInfo();
        GetCanvas()->Refresh();
    }
 
    updateTitle();
 
    if( m_infoBar->GetMessageType() == WX_INFOBAR::MESSAGE_TYPE::OUTDATED_SAVE )
        m_infoBar->Dismiss();
 
    if( backupReporter.HasMessage() )
    {
        wxString backupMsg = backupReporter.GetMessages();
        m_infoBar->ShowMessageFor( backupMsg.Trim(), 10000, wxICON_WARNING );
    }
 
    return success;
}
 
 
bool SCH_EDIT_FRAME::importFile( const wxString& aFileName, int aFileType,
                                 const std::map<std::string, UTF8>* aProperties )
{
    bool                   success = true;
    wxFileName             filename( aFileName );
    wxFileName             newfilename;
    SCH_IO_MGR::SCH_FILE_T fileType = (SCH_IO_MGR::SCH_FILE_T) aFileType;
 
    wxCommandEvent changingEvt( EDA_EVT_SCHEMATIC_CHANGING );
    ProcessEventLocally( changingEvt );
 
    if( KISTATUSBAR* statusBar = dynamic_cast<KISTATUSBAR*>( GetStatusBar() ) )
        statusBar->ClearWarningMessages( "load" );
 
    WX_STRING_REPORTER loadReporter;
    LOAD_INFO_REPORTER_SCOPE loadReporterScope( &loadReporter );
 
    std::unique_ptr<SCHEMATIC> newSchematic = std::make_unique<SCHEMATIC>( &Prj() );
 
    switch( fileType )
    {
    case SCH_IO_MGR::SCH_ALTIUM:
    case SCH_IO_MGR::SCH_CADSTAR_ARCHIVE:
    case SCH_IO_MGR::SCH_EAGLE:
    case SCH_IO_MGR::SCH_LTSPICE:
    case SCH_IO_MGR::SCH_EASYEDA:
    case SCH_IO_MGR::SCH_EASYEDAPRO:
    case SCH_IO_MGR::SCH_EASYEDAPRO_V3:
    case SCH_IO_MGR::SCH_PADS:
    case SCH_IO_MGR::SCH_GEDA:
    case SCH_IO_MGR::SCH_DIPTRACE:
    case SCH_IO_MGR::SCH_PCAD:
    case SCH_IO_MGR::SCH_ORCAD:
    case SCH_IO_MGR::SCH_EASYPC:
    {
        // We insist on caller sending us an absolute path, if it does not, we say it's a bug.
        // Unless we are passing the files in aproperties, in which case aFileName can be empty.
        wxCHECK_MSG( aFileName.IsEmpty() || filename.IsAbsolute(), false,
                     wxS( "Import schematic: path is not absolute!" ) );
 
        try
        {
            IO_RELEASER<SCH_IO>  pi( SCH_IO_MGR::FindPlugin( fileType ) );
            DIALOG_HTML_REPORTER errorReporter( this );
            WX_PROGRESS_REPORTER progressReporter( this, _( "Import Schematic" ), 1, PR_CAN_ABORT );
 
            if( PROJECT_CHOOSER_PLUGIN* c_pi = dynamic_cast<PROJECT_CHOOSER_PLUGIN*>( pi.get() ) )
            {
                c_pi->RegisterCallback( std::bind( DIALOG_IMPORT_CHOOSE_PROJECT::RunModal,
                                                   this, std::placeholders::_1 ) );
            }
 
            if( eeconfig()->m_System.show_import_issues )
                pi->SetReporter( errorReporter.m_Reporter );
            else
                pi->SetReporter( &NULL_REPORTER::GetInstance() );
 
            pi->SetProgressReporter( &progressReporter );
 
            SCH_SHEET* loadedSheet = pi->LoadSchematicFile( aFileName, newSchematic.get(), nullptr, aProperties );
 
            SetSchematic( newSchematic.release() );
 
            LoadProjectSettings();
 
            // SetSchematic() killed the previous schematic's history saver
            // So we need a new one for the new schematic
            ProjectChanged();
 
            if( loadedSheet )
            {
                std::vector<SCH_SHEET*> topLevelSheets = Schematic().GetTopLevelSheets();
                bool loadedIsTopLevel = std::find( topLevelSheets.begin(), topLevelSheets.end(), loadedSheet )
                                        != topLevelSheets.end();
                bool loadedIsVirtualRoot = loadedSheet == &Schematic().Root()
                                           || loadedSheet->IsVirtualRootSheet();
 
                // Some importers create the full top-level sheet set themselves.  Do not collapse
                // that back to the returned sheet.
                if( !loadedIsTopLevel && !loadedIsVirtualRoot )
                    Schematic().SetTopLevelSheets( { loadedSheet } );
 
                // extract a project symbol library and re-link LIB_IDs so every symbol resolves
                ReconcileImportedSymbols( *pi, Schematic(), Prj(), aFileName, aProperties, loadReporter );
 
                // re-link footprint fields to the project lib so update-from-schematic works
                {
                    wxString              cacheNick;
                    std::vector<wxString> sourceFpLibs;
                    IMPORT_PROJ_PROPS::ReadFootprintProps( aProperties, cacheNick, sourceFpLibs );
 
                    SCH_FOOTPRINT_FIELD_RECONCILER fpReconciler( cacheNick, sourceFpLibs, &loadReporter );
                    fpReconciler.Reconcile( Schematic() );
                }
 
                if( errorReporter.m_Reporter->HasMessage() )
                {
                    errorReporter.m_Reporter->Flush(); // Build HTML messages
                    errorReporter.ShowModal();
 
                    // These are not catastrophic errors: leave success set to true so the caller
                    // doesn't destroy the frame.
                }
 
                const wxString drawingSheetName = Schematic().Settings().m_SchDrawingSheetFileName;
                const wxString embeddedPrefix = wxS( "kicad-embed://" );
                const EMBEDDED_FILES::EMBEDDED_FILE* embeddedWorksheet = nullptr;
 
                if( drawingSheetName.StartsWith( embeddedPrefix ) )
                {
                    wxString sheetFile = drawingSheetName.Mid( embeddedPrefix.length() );
                    embeddedWorksheet = Schematic().GetEmbeddedFiles()->GetEmbeddedFile( sheetFile );
                }
 
                if( !embeddedWorksheet
                    || embeddedWorksheet->type != EMBEDDED_FILES::EMBEDDED_FILE::FILE_TYPE::WORKSHEET )
                {
                    DS_DATA_MODEL::GetTheInstance().SetEmptyLayout();
                    BASE_SCREEN::m_DrawingSheetFileName = DS_DATA_MODEL::EmptyLayoutName();
                }
                else
                {
                    BASE_SCREEN::m_DrawingSheetFileName = Schematic().Settings().m_SchDrawingSheetFileName;
                    LoadDrawingSheet();
                }
 
                newfilename.SetPath( Prj().GetProjectPath() );
                newfilename.SetName( Prj().GetProjectName() );
                newfilename.SetExt( FILEEXT::KiCadSchematicFileExtension );
 
                SetScreen( Schematic().RootScreen() );
 
                if( SCH_SHEET* topSheet = Schematic().GetTopLevelSheet() )
                    topSheet->SetFileName( newfilename.GetFullName() );
 
                GetScreen()->SetFileName( newfilename.GetFullPath() );
                GetScreen()->SetContentModified();
 
                progressReporter.Report( _( "Updating connections..." ) );
 
                if( !progressReporter.KeepRefreshing() )
                    THROW_IO_CANCELLED();
 
                RecalculateConnections( nullptr, GLOBAL_CLEANUP, &progressReporter );
 
                // Only perform the dangling end test on root sheet.
                GetScreen()->TestDanglingEnds();
            }
            else
            {
                CreateDefaultScreens();
            }
        }
        catch( const IO_ERROR& ioe )
        {
            // Do not leave g_RootSheet == NULL because it is expected to be
            // a valid sheet. Therefore create a dummy empty root sheet and screen.
            CreateDefaultScreens();
            m_toolManager->RunAction( ACTIONS::zoomFitScreen );
 
            wxString msg = wxString::Format( _( "Error loading schematic '%s'." ), aFileName );
            DisplayErrorMessage( this, msg, ioe.What() );
 
            msg.Printf( _( "Failed to load '%s'." ), aFileName );
            SetMsgPanel( wxEmptyString, msg );
 
            success = false;
        }
        catch( const std::exception& exc )
        {
            CreateDefaultScreens();
            m_toolManager->RunAction( ACTIONS::zoomFitScreen );
 
            wxString msg = wxString::Format( _( "Unhandled exception occurred loading schematic '%s'." ), aFileName );
            DisplayErrorMessage( this, msg, exc.what() );
 
            msg.Printf( _( "Failed to load '%s'." ), aFileName );
            SetMsgPanel( wxEmptyString, msg );
 
            success = false;
        }
 
        ClearUndoRedoList();
        ClearRepeatItemsList();
 
        initScreenZoom();
        SetSheetNumberAndCount();
        SyncView();
 
        UpdateHierarchyNavigator( false, true );
        UpdateVariantSelectionCtrl( m_schematic->GetVariantNamesForUI() );
        SetCurrentVariant( m_schematic->GetCurrentVariant() );
 
        CallAfter(
                [this]()
                {
                    if( m_netNavigator && m_netNavigatorStale )
                        RefreshNetNavigator();
                } );
 
        wxCommandEvent e( EDA_EVT_SCHEMATIC_CHANGED );
        ProcessEventLocally( e );
 
        for( wxEvtHandler* listener : m_schematicChangeListeners )
        {
            wxCHECK2( listener, continue );
 
            // Use the windows variant when handling event messages in case there is any
            // special event handler pre and/or post processing specific to windows.
            wxWindow* win = dynamic_cast<wxWindow*>( listener );
 
            if( win )
                win->HandleWindowEvent( e );
            else
                listener->SafelyProcessEvent( e );
        }
 
        updateTitle();
 
        if( KISTATUSBAR* statusBar = dynamic_cast<KISTATUSBAR*>( GetStatusBar() ) )
            statusBar->AddWarningMessages( "load", loadReporter.GetMessages() );
 
        break;
    }
 
    default:
        break;
    }
 
    return success;
}
 
 
bool SCH_EDIT_FRAME::AskToSaveChanges()
{
    SCH_SCREENS screenList( Schematic().Root() );
 
    // Save any currently open and modified project files.
    for( SCH_SCREEN* screen = screenList.GetFirst(); screen; screen = screenList.GetNext() )
    {
        SIMULATOR_FRAME* simFrame = (SIMULATOR_FRAME*) Kiway().Player( FRAME_SIMULATOR, false );
 
        // Simulator must be closed before loading another schematic, otherwise it may crash.
        // If there are any changes in the simulator the user will be prompted to save them.
        if( simFrame && !simFrame->Close() )
            return false;
 
        if( screen->IsContentModified() )
        {
            if( !HandleUnsavedChanges( this, _( "The current schematic has been modified.  Save changes?" ),
                                       [&]() -> bool
                                       {
                                           return SaveProject();
                                       } ) )
            {
                return false;
            }
        }
    }
 
    return true;
}