70#include <wx/filedlg.h>
72#include <wx/richmsgdlg.h>
73#include <wx/stdpaths.h>
84#include "widgets/filedlg_hook_save_project.h"
97 if( aFileSet.size() != 1 )
99 msg.Printf(
"Eeschema:%s() takes only a single filename.", __WXFUNCTION__ );
104 wxString fullFileName( aFileSet[0] );
105 wxFileName wx_filename( fullFileName );
108 wxASSERT_MSG( wx_filename.IsAbsolute(), wxS(
"Path is not absolute!" ) );
112 msg.Printf(
_(
"Schematic '%s' is already open by '%s' at '%s'." ), fullFileName,
128 wxFileName pro = fullFileName;
131 bool is_new = !wxFileName::IsFileReadable( fullFileName );
137 msg.Printf(
_(
"Schematic '%s' does not exist. Do you wish to create it?" ),
140 if( !
IsOK(
this, msg ) )
144 wxCommandEvent e( EDA_EVT_SCHEMATIC_CHANGING );
145 ProcessEventLocally( e );
155 SetStatusText( wxEmptyString );
159 :
_(
"Loading Schematic" ), 1 );
163 if( differentProject )
165 if( !
Prj().IsNullProject() )
176 wxFileName legacyPro( pro );
181 if( !pro.Exists() && !legacyPro.Exists() && !( aCtl &
KICTL_CREATE ) )
189 if( schFileType == SCH_IO_MGR::SCH_LEGACY )
219 rfn.MakeRelativeTo(
Prj().GetProjectPath() );
229 if( is_new || schFileType == SCH_IO_MGR::SCH_FILE_T::SCH_FILE_UNKNOWN )
235 if( schFileType == SCH_IO_MGR::SCH_FILE_T::SCH_FILE_UNKNOWN )
237 msg.Printf(
_(
"Unsupported schematic file '%s'." ), fullFileName );
238 progressReporter.Hide();
244 wxFileName autoSaveFn = fullFileName;
247 autoSaveFn.ClearExt();
263 pi->SetProgressReporter( &progressReporter );
265 bool failedLoad =
false;
275 wxLogDebug(
"Loaded schematic with root sheet UUID %s",
Schematic().Root().m_Uuid.AsString() );
278 if( !pi->GetError().IsEmpty() )
281 "occurred attempting to load hierarchical sheets." ),
287 msg.Printf(
_(
"Error loading schematic '%s'." ), fullFileName);
288 progressReporter.Hide();
295 msg.Printf(
_(
"Error loading schematic '%s'." ), fullFileName);
296 progressReporter.Hide();
301 catch(
const std::bad_alloc& )
303 msg.Printf(
_(
"Memory exhausted loading schematic '%s'." ), fullFileName );
304 progressReporter.Hide();
322 msg.Printf(
_(
"Failed to load '%s'." ), fullFileName );
335 _(
"An error was found when loading the schematic that has "
336 "been automatically fixed. Please save the schematic to "
337 "repair the broken file or it may not be usable with other "
338 "versions of KiCad." ) );
349 if( schFileType == SCH_IO_MGR::SCH_LEGACY )
354 std::vector<SCH_ITEM*> deleted;
356 for(
SCH_ITEM* item : screen->Items() )
361 std::unique_ptr<SCH_LINE> wire = std::make_unique<SCH_LINE>();
365 wire->SetEndPoint( entry->
GetEnd() );
367 screen->Append( wire.release() );
368 deleted.push_back( item );
373 screen->Remove( item );
389 wxArrayString libNames;
393 if( !libNames.IsEmpty() )
395 if(
eeconfig()->m_Appearance.show_illegal_symbol_lib_dialog )
397 wxRichMessageDialog invalidLibDlg(
399 _(
"Illegal entry found in project file symbol library list." ),
400 _(
"Project Load Warning" ),
401 wxOK | wxCENTER | wxICON_EXCLAMATION );
402 invalidLibDlg.ShowDetailedText(
403 _(
"Symbol libraries defined in the project file symbol library "
404 "list are no longer supported and will be removed.\n\n"
405 "This may cause broken symbol library links under certain "
407 invalidLibDlg.ShowCheckBox(
_(
"Do not show this dialog again." ) );
408 invalidLibDlg.ShowModal();
410 !invalidLibDlg.IsCheckBoxChecked();
421 editor->RescueSymbolLibTableProject(
false );
431 wxFileName cacheFn = pro;
433 cacheFn.SetName( cacheFn.GetName() +
"-cache" );
436 msg.Printf(
_(
"The project symbol library cache file '%s' was not found." ),
437 cacheFn.GetFullName() );
438 extMsg =
_(
"This can result in a broken schematic under certain conditions. "
439 "If the schematic does not have any missing symbols upon opening, "
440 "save it immediately before making any changes to prevent data "
441 "loss. If there are missing symbols, either manual recovery of "
442 "the schematic or recovery of the symbol cache library file and "
443 "reloading the schematic is required." );
445 wxMessageDialog dlgMissingCache(
this, msg,
_(
"Warning" ),
446 wxOK | wxCANCEL | wxICON_EXCLAMATION | wxCENTER );
447 dlgMissingCache.SetExtendedMessage( extMsg );
448 dlgMissingCache.SetOKCancelLabels(
449 wxMessageDialog::ButtonLabel(
_(
"Load Without Cache File" ) ),
450 wxMessageDialog::ButtonLabel(
_(
"Abort" ) ) );
452 if( dlgMissingCache.ShowModal() == wxID_CANCEL )
466 "It will be converted to the new format when saved." ),
474 screen->FixLegacyPowerSymbolMismatches();
486 "It will be converted to the new format when saved." ),
491 screen->UpdateLocalLibSymbolLinks();
494 if(
Schematic().RootScreen()->GetFileFormatVersionAtLoad() < 20221002 )
497 if(
Schematic().RootScreen()->GetFileFormatVersionAtLoad() < 20221110 )
500 if(
Schematic().RootScreen()->GetFileFormatVersionAtLoad() < 20230221 )
502 screen->FixLegacyPowerSymbolMismatches();
505 screen->MigrateSimModels();
523 if(
Schematic().ConnectionGraph()->GetBusesNeedingMigration().size() > 0 )
552 if( schFileType == SCH_IO_MGR::SCH_LEGACY )
562 wxCommandEvent changedEvt( EDA_EVT_SCHEMATIC_CHANGED );
563 ProcessEventLocally( changedEvt );
567 wxCHECK2( listener,
continue );
571 wxWindow* win =
dynamic_cast<wxWindow*
>( listener );
574 win->HandleWindowEvent( e );
576 listener->SafelyProcessEvent( e );
584 if( fn.FileExists() && !fn.IsFileWritable() )
609 wxLogError( wxS(
"Document not ready, cannot import" ) );
614 wxString
path = wxPathOnly(
Prj().GetProjectFullName() );
616 wxFileDialog dlg(
this,
_(
"Insert Schematic" ),
path, wxEmptyString,
619 if( dlg.ShowModal() == wxID_CANCEL )
666 commit.
Push(
_(
"Import Schematic Sheet Content..." ) );
678 wxString msg =
_(
"This operation cannot be undone.\n\n"
679 "Do you want to save the current document before proceeding?" );
681 if(
IsOK(
this, msg ) )
693 wxString msg =
_(
"This operation replaces the contents of the current schematic, "
694 "which will be permanently lost.\n\n"
695 "Do you want to proceed?" );
697 if( !
IsOK(
this, msg ) )
703 wxString
path = wxPathOnly(
Prj().GetProjectFullName() );
705 wxString fileFiltersStr;
706 wxString allWildcardsStr;
708 for(
const SCH_IO_MGR::SCH_FILE_T&
fileType : SCH_IO_MGR::SCH_FILE_T_vector )
710 if(
fileType == SCH_IO_MGR::SCH_KICAD ||
fileType == SCH_IO_MGR::SCH_LEGACY )
723 if( !fileFiltersStr.IsEmpty() )
724 fileFiltersStr += wxChar(
'|' );
732 fileFiltersStr =
_(
"All supported formats" ) + wxS(
"|" ) + allWildcardsStr + wxS(
"|" )
735 wxFileDialog dlg(
this,
_(
"Import Schematic" ),
path, wxEmptyString, fileFiltersStr,
736 wxFD_OPEN | wxFD_FILE_MUST_EXIST );
739 dlg.SetCustomizeHook( importOptions );
741 if( dlg.ShowModal() == wxID_CANCEL )
760 wxFileName projectFn( dlg.GetPath() );
767 wxFileName fn = dlg.GetPath();
769 if( !fn.IsFileReadable() )
771 wxLogError(
_(
"Insufficient permissions to read file '%s'." ), fn.GetFullPath() );
775 SCH_IO_MGR::SCH_FILE_T pluginType = SCH_IO_MGR::SCH_FILE_T::SCH_FILE_UNKNOWN;
777 for(
const SCH_IO_MGR::SCH_FILE_T&
fileType : SCH_IO_MGR::SCH_FILE_T_vector )
784 if( pi->CanReadSchematicFile( fn.GetFullPath() ) )
791 if( pluginType == SCH_IO_MGR::SCH_FILE_T::SCH_FILE_UNKNOWN )
793 wxLogError(
_(
"No loader can read the specified file: '%s'." ), fn.GetFullPath() );
808 wxFileName schematicFileName;
809 wxFileName oldFileName;
814 wxCHECK( screen,
false );
817 wxCHECK( !aSavePath.IsEmpty(),
false );
821 oldFileName = schematicFileName;
829 wxFileName projectFile( schematicFileName );
833 if( projectFile.FileExists() )
840 wxString tempFile = wxFileName::CreateTempFileName( wxS(
"eeschema" ) );
843 wxLogTrace(
traceAutoSave, wxS(
"Saving file " ) + schematicFileName.GetFullPath() );
849 schematicFileName.GetFullPath() );
851 if( pluginType == SCH_IO_MGR::SCH_FILE_UNKNOWN )
852 pluginType = SCH_IO_MGR::SCH_KICAD;
858 pi->SaveSchematicFile( tempFile, aSheet, &
Schematic() );
863 msg.Printf(
_(
"Error saving schematic file '%s'.\n%s" ),
864 schematicFileName.GetFullPath(),
868 msg.Printf(
_(
"Failed to create temporary file '%s'." ),
873 wxRemoveFile( tempFile );
884 success = wxRenameFile( tempFile, schematicFileName.GetFullPath() );
888 msg.Printf(
_(
"Error saving schematic file '%s'.\n"
889 "Failed to rename temporary file '%s'." ),
890 schematicFileName.GetFullPath(),
894 msg.Printf(
_(
"Failed to rename temporary file '%s'." ),
903 wxFileName autoSaveFileName = schematicFileName;
906 if( autoSaveFileName.FileExists() )
909 wxS(
"Removing auto save file <" ) + autoSaveFileName.GetFullPath() +
912 wxRemoveFile( autoSaveFileName.GetFullPath() );
917 msg.Printf(
_(
"File '%s' saved." ), screen->
GetFileName() );
918 SetStatusText( msg, 0 );
936 bool updateFileHistory =
false;
937 bool createNewProject =
false;
941 wxFileName fn = fileName;
945 std::unordered_map<SCH_SCREEN*, wxString> filenameMap;
948 if(
Prj().IsNullProject() || aSaveAs )
951 wxCHECK(
Kiface().IsSingle() || aSaveAs,
false );
953 wxFileName newFileName;
954 wxFileName savePath(
Prj().GetProjectFullName() );
956 if( !savePath.IsOk() || !savePath.IsDirWritable() )
960 if( !savePath.IsOk() || !savePath.IsDirWritable() )
964 if( savePath.HasExt() )
967 savePath.SetName( wxEmptyString );
969 wxFileDialog dlg(
this,
_(
"Schematic Files" ), savePath.GetPath(), savePath.GetFullName(),
971 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
976 if(
Kiface().IsSingle() || aSaveAs )
978 dlg.SetCustomizeHook( newProjectHook );
981 if( dlg.ShowModal() == wxID_CANCEL )
986 if( ( !newFileName.DirExists() && !newFileName.Mkdir() ) ||
987 !newFileName.IsDirWritable() )
989 msg.Printf(
_(
"Folder '%s' could not be created.\n\n"
990 "Make sure you have write permissions and try again." ),
991 newFileName.GetPath() );
993 wxMessageDialog dlgBadPath(
this, msg,
_(
"Error" ),
994 wxOK | wxICON_EXCLAMATION | wxCENTER );
996 dlgBadPath.ShowModal();
1007 updateFileHistory =
true;
1015 for(
size_t i = 0; i < screens.
GetCount(); i++ )
1019 wxCHECK2( screen,
continue );
1022 if( screen ==
Schematic().RootScreen() )
1030 if( tmp.FileExists() )
1033 if( tmp.GetPath().IsEmpty() )
1035 tmp.SetPath( newFileName.GetPath() );
1037 else if( tmp.GetPath() == fn.GetPath() )
1039 tmp.SetPath( newFileName.GetPath() );
1041 else if( tmp.GetPath().StartsWith( fn.GetPath() ) )
1045 wxString newPath = newFileName.GetPath();
1046 newPath += tmp.GetPath().Right( fn.GetPath().Length() );
1047 tmp.SetPath( newPath );
1051 wxS(
"Moving schematic from '%s' to '%s'." ),
1053 tmp.GetFullPath() );
1055 if( !tmp.DirExists() && !tmp.Mkdir() )
1057 msg.Printf(
_(
"Folder '%s' could not be created.\n\n"
1058 "Make sure you have write permissions and try again." ),
1059 newFileName.GetPath() );
1061 wxMessageDialog dlgBadFilePath(
this, msg,
_(
"Error" ),
1062 wxOK | wxICON_EXCLAMATION | wxCENTER );
1064 dlgBadFilePath.ShowModal();
1069 filenameMap[screen] = tmp.GetFullPath();
1079 if( sheet.Last()->IsRootSheet() )
1082 sheet.MakeFilePathRelativeToParentSheet();
1085 else if( !fn.FileExists() )
1088 updateFileHistory =
true;
1090 else if( !
Schematic().GetSheets().IsModified() )
1095 if( filenameMap.empty() || !saveCopy )
1097 for(
size_t i = 0; i < screens.
GetCount(); i++ )
1102 wxArrayString overwrittenFiles;
1103 wxArrayString lockedFiles;
1105 for(
size_t i = 0; i < screens.
GetCount(); i++ )
1109 wxCHECK2( screen,
continue );
1112 wxFileName tmpFn = filenameMap[screen];
1117 if( tmpFn.FileExists() && !tmpFn.IsFileWritable() )
1118 lockedFiles.Add( tmpFn.GetFullPath() );
1125 if( tmpFn.FileExists() )
1126 overwrittenFiles.Add( tmpFn.GetFullPath() );
1129 if( !lockedFiles.IsEmpty() )
1131 for(
const wxString& lockedFile : lockedFiles )
1136 msg +=
"\n" + lockedFile;
1139 wxRichMessageDialog dlg(
this, wxString::Format(
_(
"Failed to save %s." ),
1141 _(
"Locked File Warning" ),
1142 wxOK | wxICON_WARNING | wxCENTER );
1143 dlg.SetExtendedMessage(
_(
"You do not have write permissions to:\n\n" ) + msg );
1149 if( !overwrittenFiles.IsEmpty() )
1151 for(
const wxString& overwrittenFile : overwrittenFiles )
1154 msg = overwrittenFile;
1156 msg +=
"\n" + overwrittenFile;
1159 wxRichMessageDialog dlg(
this,
_(
"Saving will overwrite existing files." ),
1160 _(
"Save Warning" ),
1161 wxOK | wxCANCEL | wxCANCEL_DEFAULT | wxCENTER |
1162 wxICON_EXCLAMATION );
1163 dlg.ShowDetailedText(
_(
"The following files will be overwritten:\n\n" ) + msg );
1164 dlg.SetOKCancelLabels( wxMessageDialog::ButtonLabel(
_(
"Overwrite Files" ) ),
1165 wxMessageDialog::ButtonLabel(
_(
"Abort Project Save" ) ) );
1167 if( dlg.ShowModal() == wxID_CANCEL )
1173 for(
size_t i = 0; i < screens.
GetCount(); i++ )
1177 wxCHECK2( screen,
continue );
1180 wxFileName tmpFn = filenameMap[screen];
1184 updateFileHistory =
true;
1192 if( !sheetFileName.IsOk()
1197 sheet->
SetFileName( sheetFileName.GetFullPath() );
1201 filenameMap[screen] = tmpFn.GetFullPath();
1213 if( sheets.size() == 1 )
1219 if( !saveCopy && tmpFn.GetFullPath() != screen->
GetFileName() )
1229 if( !aSaveAs && !success )
1232 if( aSaveAs && success )
1235 if( updateFileHistory )
1246 wxCHECK2( sheet,
continue );
1253 wxCHECK2( screen,
continue );
1255 sheets.emplace_back( std::make_pair( screen->
GetUuid(), sheet->
GetName() ) );
1259 sheets.emplace_back( std::make_pair( sheet->
m_Uuid, sheet->
GetName() ) );
1263 wxASSERT( filenameMap.count(
Schematic().RootScreen() ) );
1264 wxFileName projectPath( filenameMap.at(
Schematic().RootScreen() ) );
1267 if(
Prj().IsNullProject() || ( aSaveAs && !saveCopy ) )
1272 else if( saveCopy && createNewProject )
1282 if( !
Kiface().IsSingle() )
1287 SetStatusText( msg, 0 );
1302 wxFileName fn = tmpFileName;
1310 bool autoSaveOk =
true;
1312 if( fn.GetPath().IsEmpty() )
1313 tmp.AssignDir(
Prj().GetProjectPath() );
1315 tmp.AssignDir( fn.GetPath() );
1323 wxString title = GetTitle();
1325 for(
size_t i = 0; i < screens.
GetCount(); i++ )
1368 wxFileName filename( aFileName );
1369 wxFileName newfilename;
1371 SCH_IO_MGR::SCH_FILE_T
fileType = (SCH_IO_MGR::SCH_FILE_T) aFileType;
1373 wxCommandEvent changingEvt( EDA_EVT_SCHEMATIC_CHANGING );
1374 ProcessEventLocally( changingEvt );
1378 case SCH_IO_MGR::SCH_ALTIUM:
1379 case SCH_IO_MGR::SCH_CADSTAR_ARCHIVE:
1380 case SCH_IO_MGR::SCH_EAGLE:
1381 case SCH_IO_MGR::SCH_LTSPICE:
1382 case SCH_IO_MGR::SCH_EASYEDA:
1383 case SCH_IO_MGR::SCH_EASYEDAPRO:
1386 wxCHECK_MSG( filename.IsAbsolute(),
false,
1387 wxS(
"Import schematic: path is not absolute!" ) );
1398 if( projectChooserPlugin )
1402 std::placeholders::_1 ) );
1410 pi->SetProgressReporter( &progressReporter );
1413 pi->LoadSchematicFile( aFileName, &
Schematic(),
nullptr, aProperties );
1422 errorReporter.ShowModal();
1431 newfilename.SetPath(
Prj().GetProjectPath() );
1432 newfilename.SetName(
Prj().GetProjectName() );
1458 wxString msg = wxString::Format(
_(
"Error loading schematic '%s'." ), aFileName );
1461 msg.Printf(
_(
"Failed to load '%s'." ), aFileName );
1464 catch(
const std::exception& exc )
1469 wxString msg = wxString::Format(
_(
"Unhandled exception occurred loading schematic "
1470 "'%s'." ), aFileName );
1473 msg.Printf(
_(
"Failed to load '%s'." ), aFileName );
1485 wxCommandEvent e( EDA_EVT_SCHEMATIC_CHANGED );
1486 ProcessEventLocally( e );
1490 wxCHECK2( listener,
continue );
1494 wxWindow* win =
dynamic_cast<wxWindow*
>( listener );
1497 win->HandleWindowEvent( e );
1499 listener->SafelyProcessEvent( e );
1525 if( simFrame && !simFrame->Close() )
1528 if( screen->IsContentModified() )
1551 wxLogTrace(
traceAutoSave,
"Creating auto save file %s", autoSaveFileName.GetFullPath() );
1553 wxCHECK( autoSaveFileName.IsDirWritable(),
false );
1557 std::vector< wxString > autoSavedFiles;
1559 for(
size_t i = 0; i < screens.
GetCount(); i++ )
1569 autoSavedFiles.emplace_back( fn.GetFullPath() );
1572 wxTextFile autoSaveFile( autoSaveFileName.GetFullPath() );
1574 if( autoSaveFileName.FileExists() && !wxRemoveFile( autoSaveFileName.GetFullPath() ) )
1576 wxLogTrace(
traceAutoSave,
"Error removing auto save file %s",
1577 autoSaveFileName.GetFullPath() );
1583 if( autoSavedFiles.empty() )
1586 if( !autoSaveFile.Create() )
1589 for(
const wxString& fileName : autoSavedFiles )
1591 wxLogTrace(
traceAutoSave,
"Adding auto save file %s to %s",
1592 fileName, autoSaveFileName.GetName() );
1593 autoSaveFile.AddLine( fileName );
1596 if( !autoSaveFile.Write() )
1599 wxLogTrace(
traceAutoSave,
"Auto save file '%s' written", autoSaveFileName.GetFullName() );
1605void removeFile(
const wxString& aFilename, wxArrayString& aUnremoved )
1607 wxLogTrace(
traceAutoSave, wxS(
"Removing auto save file " ) + aFilename );
1609 if( wxFileExists( aFilename ) && !wxRemoveFile( aFilename ) )
1610 aUnremoved.Add( aFilename );
1616 if( !
Pgm().IsGUI() )
1619 wxCHECK_RET( aFileName.IsOk(), wxS(
"Invalid file name!" ) );
1622 wxS(
"Checking for auto save file " ) + aFileName.GetFullPath() );
1624 if( !aFileName.FileExists() )
1628 "Well this is potentially embarrassing!\n"
1629 "It appears that the last time you were editing one or more of the schematic files\n"
1630 "were not saved properly. Do you wish to restore the last saved edits you made?" );
1632 int response = wxMessageBox( msg,
Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
1635 wxTextFile fileList( aFileName.GetFullPath() );
1637 if( !fileList.Open() )
1639 msg.Printf(
_(
"The file '%s' could not be opened.\n"
1640 "Manual recovery of automatically saved files is required." ),
1641 aFileName.GetFullPath() );
1643 wxMessageBox( msg,
Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION,
this );
1647 if( response == wxYES )
1649 wxArrayString unrecoveredFiles;
1651 for( wxString fn = fileList.GetFirstLine(); !fileList.Eof(); fn = fileList.GetNextLine() )
1653 wxFileName recoveredFn = fn;
1654 wxString tmp = recoveredFn.GetName();
1658 recoveredFn.SetName( tmp );
1660 wxFileName backupFn = recoveredFn;
1664 wxLogTrace(
traceAutoSave, wxS(
"Recovering auto save file:\n"
1665 " Original file: '%s'\n"
1666 " Backup file: '%s'\n"
1667 " Auto save file: '%s'" ),
1668 recoveredFn.GetFullPath(), backupFn.GetFullPath(), fn );
1670 if( !wxFileExists( fn ) )
1672 unrecoveredFiles.Add( recoveredFn.GetFullPath() );
1676 else if( !wxCopyFile( recoveredFn.GetFullPath(), backupFn.GetFullPath() ) )
1678 unrecoveredFiles.Add( recoveredFn.GetFullPath() );
1681 else if( !wxRenameFile( fn, recoveredFn.GetFullPath() ) )
1683 unrecoveredFiles.Add( recoveredFn.GetFullPath() );
1687 if( !unrecoveredFiles.IsEmpty() )
1689 msg =
_(
"The following automatically saved file(s) could not be restored\n" );
1691 for(
size_t i = 0; i < unrecoveredFiles.GetCount(); i++ )
1692 msg += unrecoveredFiles[i] + wxS(
"\n" );
1694 msg +=
_(
"Manual recovery will be required to restore the file(s) above." );
1695 wxMessageBox( msg,
Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION,
1699 wxArrayString unremovedFiles;
1700 removeFile( aFileName.GetFullPath(), unremovedFiles );
1702 if( !unremovedFiles.IsEmpty() )
1704 msg.Printf(
_(
"The autosave file '%s' could not be removed.\n"
1705 "Manual removal will be required." ),
1706 unremovedFiles[0] );
1708 wxMessageBox( msg,
Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION,
this );
1720 if( !
Pgm().IsGUI() )
1723 wxCHECK_RET( aFileName.IsOk(), wxS(
"Invalid file name!" ) );
1725 if( !aFileName.FileExists() )
1728 wxTextFile fileList( aFileName.GetFullPath() );
1729 wxArrayString unremovedFiles;
1731 for( wxString fn = fileList.GetFirstLine(); !fileList.Eof(); fn = fileList.GetNextLine() )
1734 removeFile( aFileName.GetFullPath(), unremovedFiles );
1736 if( !unremovedFiles.IsEmpty() )
1738 wxString msg =
_(
"The following automatically saved file(s) could not be removed\n" );
1740 for(
size_t i = 0; i < unremovedFiles.GetCount(); i++ )
1741 msg += unremovedFiles[i] + wxS(
"\n" );
1743 msg +=
_(
"Manual removal will be required for the file(s) above." );
1744 wxMessageBox( msg,
Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION,
this );
1751 static wxString autoSaveFileName( wxS(
"#auto_saved_files#" ) );
1753 return autoSaveFileName;
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
static TOOL_ACTION zoomFitScreen
bool IsContentModified() const
void SetVirtualPageNumber(int aPageNumber)
static wxString m_DrawingSheetFileName
the name of the drawing sheet file, or empty to use the default drawing sheet
void SetContentModified(bool aModified=true)
COMMIT & Added(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Remove a new item from the model.
Class DIALOG_HTML_REPORTER.
WX_HTML_REPORT_BOX * m_Reporter
static std::vector< IMPORT_PROJECT_DESC > GetSelectionsModal(wxWindow *aParent, const std::vector< IMPORT_PROJECT_DESC > &aProjectDesc)
Create and show a dialog (modal) and returns the data from it after completion.
Handle the graphic items list to draw/plot the frame and title block.
static DS_DATA_MODEL & GetTheInstance()
static function: returns the instance of DS_DATA_MODEL used in the application
void LoadWindowState(const wxString &aFileName)
virtual void ClearUndoRedoList()
Clear the undo and redo list using ClearUndoORRedoList()
SETTINGS_MANAGER * GetSettingsManager() const
void UpdateFileHistory(const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
Update the list of recently opened files.
wxString GetMruPath() const
bool IsWritable(const wxFileName &aFileName, bool aVerbose=true)
Checks if aFileName can be written.
std::unique_ptr< LOCKFILE > m_file_checker
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
void RefreshCanvas() override
bool LockFile(const wxString &aFileName)
Mark a schematic file as being in use.
A base class for most all the KiCad significant classes used in schematics and boards.
EE_TYPE OfType(KICAD_T aType) const
bool GetCreateNewProject() const
Gets if this hook has attached controls to a dialog box.
bool IsAttachedToDialog() const
bool GetShowIssues() const
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString What() const
A composite of Problem() and Where()
virtual const wxString Problem() const
what was the problem?
APP_SETTINGS_BASE * KifaceSettings() const
bool IsSingle() const
Is this KIFACE running under single_top?
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
static REPORTER & GetInstance()
static wxString GetDefaultUserProjectsPath()
Gets the default path we point users to create projects.
A small class to help profiling.
void Show(std::ostream &aStream=std::cerr)
Print the elapsed time (in a suitable unit) to a stream.
Plugin class for import plugins that support choosing a project.
virtual void RegisterChooseProjectCallback(CHOOSE_PROJECT_HANDLER aChooseProjectHandler)
Register a different handler to be called when a non-KiCad project contains multiple PCB+Schematic co...
std::vector< FILE_INFO_PAIR > & GetSheets()
static SYMBOL_LIB_TABLE * SchSymbolLibTable(PROJECT *aProject)
Accessor for project symbol library table.
static SYMBOL_LIBS * SchLibs(PROJECT *aProject)
virtual void SetReadOnly(bool aReadOnly=true)
virtual const wxString GetProjectFullName() const
Return the full path and name of the project.
virtual PROJECT_FILE & GetProjectFile() const
virtual void SetElem(ELEM_T aIndex, _ELEM *aElem)
virtual const wxString AbsolutePath(const wxString &aFileName) const
Fix up aFileName if it is relative to the project's directory to be an absolute path and filename.
void Reset()
Initialize this schematic to a blank one, unloading anything existing.
void ResolveERCExclusionsPostUpdate()
Update markers to match recorded exclusions.
CONNECTION_GRAPH * ConnectionGraph() const override
void FixupJunctions()
Add junctions to this schematic where required.
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
void SetRoot(SCH_SHEET *aRootSheet)
Initialize the schematic with a new root sheet.
void SetProject(PROJECT *aPrj)
SCH_SCREEN * RootScreen() const
Helper to retrieve the screen of the root sheet.
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void SyncView()
Mark all items for refresh.
EESCHEMA_SETTINGS * eeconfig() const
Class for a bus to bus entry.
VECTOR2I GetPosition() const override
virtual void Push(const wxString &aMessage=wxT("A commit"), int aCommitFlags=0) override
Revert the commit by restoring the modified items state.
virtual void Revert() override
void DisplaySheet(SCH_SCREEN *aScreen)
Handle actions specific to the schematic editor.
bool LoadSheetFromFile(SCH_SHEET *aSheet, SCH_SHEET_PATH *aCurrentSheet, const wxString &aFileName)
Load a the KiCad schematic file aFileName into the sheet aSheet.
bool IsContentModified() const override
Get if the current schematic has been modified but not saved.
const wxString & getAutoSaveFileName() const
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag and update other data struc...
void SaveProjectLocalSettings() override
Save changes to the project settings to the project (.pro) file.
bool OpenProjectFiles(const std::vector< wxString > &aFileSet, int aCtl=0) override
Open a project or set of files given by aFileList.
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
void SetScreen(BASE_SCREEN *aScreen) override
bool AskToSaveChanges()
Check if any of the screens has unsaved changes and asks the user whether to save or drop them.
bool doAutoSave() override
Save the schematic files that have been modified and not yet saved.
bool importFile(const wxString &aFileName, int aFileType, const STRING_UTF8_MAP *aProperties=nullptr)
Load the given filename but sets the path to the current project path.
void UpdateHierarchyNavigator(bool aRefreshNetNavigator=true)
Update the hierarchy navigation tree and history.
std::vector< wxEvtHandler * > m_schematicChangeListeners
void HardRedraw() override
Rebuild the GAL and redraw the screen.
void OnAppendProject(wxCommandEvent &event)
SCH_SHEET_PATH & GetCurrentSheet() const
SCHEMATIC & Schematic() const
void updateTitle()
Set the main window title bar text.
bool saveSchematicFile(SCH_SHEET *aSheet, const wxString &aSavePath)
Save aSheet to a schematic file.
bool LoadProjectSettings()
Load the KiCad project file (*.pro) settings specific to Eeschema.
void RecomputeIntersheetRefs()
Update the schematic's page reference map for all global labels, and refresh the labels so that they ...
bool updateAutoSaveFile()
virtual void DeleteAutoSaveFile(const wxFileName &aFileName) override
void SetSheetNumberAndCount()
Set the m_ScreenNumber and m_NumberOfScreens members for screens.
bool AddSheetAndUpdateDisplay(const wxString aFullFileName)
Add a sheet file into the current sheet and updates display.
void RecalculateConnections(SCH_COMMIT *aCommit, SCH_CLEANUP_FLAGS aCleanupFlags)
Generate the connection data for the entire schematic hierarchy.
void initScreenZoom()
Initialize the zoom value of the current screen and mark the screen as zoom-initialized.
void OnImportProject(wxCommandEvent &event)
bool AppendSchematic()
Import a KiCad schematic into the current sheet.
virtual void CheckForAutoSaveFile(const wxFileName &aFileName) override
This overloaded version checks if the auto save master file "#auto_saved_files#" exists and recovers ...
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false, bool aUpdateRtree=false) override
Mark an item for refresh.
wxString GetCurrentFileName() const override
Get the full filename + path of the currently opened file in the frame.
void TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
bool SaveProject(bool aSaveAs=false)
Save the currently-open schematic (including its hierarchy) and associated project.
void saveProjectSettings() override
Saves any design-related project settings associated with this frame.
static SCH_FILE_T GuessPluginTypeFromSchPath(const wxString &aSchematicPath, int aCtl=0)
Return a plugin type given a schematic using the file extension of aSchematicPath.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
SCH_SCREEN * GetScreen(unsigned int aIndex) const
void UpdateSymbolLinks(REPORTER *aReporter=nullptr)
Initialize the LIB_SYMBOL reference for each SCH_SYMBOL found in the full schematic.
void PruneOrphanedSheetInstances(const wxString &aProjectName, const SCH_SHEET_LIST &aValidSheetPaths)
void BuildClientSheetPathList()
built the list of sheet paths sharing a screen for each screen in use
void PruneOrphanedSymbolInstances(const wxString &aProjectName, const SCH_SHEET_LIST &aValidSheetPaths)
bool HasNoFullyDefinedLibIds()
Test all of the schematic symbols to see if all LIB_ID objects library nickname is not set.
SCH_SHEET * GetSheet(unsigned int aIndex) const
int ReplaceDuplicateTimeStamps()
Test all sheet and symbol objects in the schematic for duplicate time stamps and replaces them as nec...
void ClearDrawingState()
Clear the state flags of all the items in the screen.
std::vector< SCH_SHEET_PATH > & GetClientSheetPaths()
Return the number of times this screen is used.
void TestDanglingEnds(const SCH_SHEET_PATH *aPath=nullptr, std::function< void(SCH_ITEM *)> *aChangedHandler=nullptr) const
Test all of the connectable objects in the schematic for unused connection points.
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
const wxString & GetFileName() const
const KIID & GetUuid() const
void SetFileName(const wxString &aFileName)
Set the file name for this screen to aFileName.
int GetFileFormatVersionAtLoad() const
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
void UpdateSheetInstanceData(const std::vector< SCH_SHEET_INSTANCE > &aSheetInstances)
Update all of the sheet instance information using aSheetInstances.
void SetInitialPageNumbers()
Set initial sheet page numbers.
bool AllSheetPageNumbersEmpty() const
Check all of the sheet instance for empty page numbers.
bool IsModified() const
Check the entire hierarchy for any modifications.
void UpdateSymbolInstanceData(const std::vector< SCH_SYMBOL_INSTANCE > &aSymbolInstances)
Update all of the symbol instance information using aSymbolInstances.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
void UpdateAllScreenReferences() const
Update all the symbol references for this sheet path.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
void SetFileName(const wxString &aFilename)
wxString GetFileName() const
Return the filename corresponding to this sheet.
void SetName(const wxString &aName)
SCH_SCREEN * GetScreen() const
void SaveProjectAs(const wxString &aFullPath, PROJECT *aProject=nullptr)
Sets the currently loaded project path and saves it (pointers remain valid) Note that this will not m...
void SaveProjectCopy(const wxString &aFullPath, PROJECT *aProject=nullptr)
Saves a copy of the current project under the given path.
bool SaveProject(const wxString &aFullPath=wxEmptyString, PROJECT *aProject=nullptr)
Saves a loaded project.
bool LoadProject(const wxString &aFullPath, bool aSetActive=true)
Loads a project or sets up a new project with a specified path.
bool UnloadProject(PROJECT *aProject, bool aSave=true)
Saves, unloads and unregisters the given PROJECT.
bool TriggerBackupIfNeeded(REPORTER &aReporter) const
Calls BackupProject if a new backup is needed according to the current backup policy.
The SIMULATOR_FRAME holds the main user-interface for running simulations.
A name/value tuple with unique names and optional values.
A collection of SYMBOL_LIB objects.
static void SetLibNamesAndPaths(PROJECT *aProject, const wxString &aPaths, const wxArrayString &aNames)
static void GetLibNamesAndPaths(PROJECT *aProject, wxString *aPaths, wxArrayString *aNames=nullptr)
static void ResolvePossibleSymlinks(wxFileName &aFilename)
void Flush()
Build the HTML messages page.
bool HasMessage() const override
Returns true if the reporter client is non-empty.
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
@ OUTDATED_SAVE
OUTDATED_SAVE Messages that should be cleared on save.
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
void AddCloseButton(const wxString &aTooltip=_("Hide this message."))
Add the default close button to the infobar on the right side.
MESSAGE_TYPE GetMessageType() const
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
Multi-thread safe progress reporter dialog, intended for use of tasks that parallel reporting back of...
A wrapper for reporting to a wxString object.
wxString EnsureFileExtension(const wxString &aFilename, const wxString &aExtension)
It's annoying to throw up nag dialogs when the extension isn't right.
bool AskOverrideLock(wxWindow *aParent, const wxString &aMessage)
Display a dialog indicating the file is already open, with an option to reset the lock.
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
This file is part of the common library.
static bool empty(const wxTextEntryBase *aCtrl)
#define ENDPOINT
ends. (Used to support dragging.)
#define SKIP_STRUCT
flag indicating that the structure should be ignored
#define STARTPOINT
When a line is selected, these flags indicate which.
void removeFile(const wxString &aFilename, wxArrayString &aUnremoved)
static const std::string ProjectFileExtension
static const std::string LegacyProjectFileExtension
static const std::string KiCadSchematicFileExtension
static const std::string LegacySymbolLibFileExtension
static const std::string BackupFileSuffix
static const std::string AutoSaveFilePrefix
static wxString KiCadSchematicFileWildcard()
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
const wxChar *const tracePathsAndFiles
Flag to enable path and file name debug output.
std::unique_ptr< T > IO_RELEASER
Helper to hold and release an IO_BASE object when exceptions are thrown.
#define KICTL_CREATE
caller thinks requested project files may not exist.
#define KICTL_REVERT
reverting to a previously-saved (KiCad) file.
PGM_BASE & Pgm()
The global Program "get" accessor.
#define SEXPR_SCHEMATIC_FILE_VERSION
Schematic file version.
Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.
KIWAY Kiway(KFCTL_STANDALONE)
std::vector< FAB_LAYER_COLOR > dummy
MODEL3D_FORMAT_TYPE fileType(const char *aFileName)
bool show_import_issues
Stored value for "show import issues" when importing non-KiCad designs to this application.
bool show_illegal_symbol_lib_dialog
Container that describes file type info.
std::vector< std::string > m_FileExtensions
Filter used for file pickers if m_IsFile is true.
bool m_CanRead
Whether the IO can read this file type.
wxString FileFilter() const
Definition for symbol library class.
wxLogTrace helper definitions.
wxString formatWildcardExt(const wxString &aWildcard)
Format wildcard extension to support case sensitive file dialogs.
Definition of file extensions used in Kicad.