haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Eeschema: minor remapping improvements. 

Create separate folder in project path to backup files changed during
remapping.

Add time stamp to backup file names in case multiple remappings are
performed.

Add backup file information to report panel instead of using debug
trace messages.

Disable the remap button if the user does not have write privileges to
the current project path.
This commit is contained in:
Wayne Stambaugh 2018-01-03 11:25:19 -05:00
parent bf44d394c3
commit 202cd43864
2 changed files with 80 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
eeschema/dialogs/dialog_symbol_remap.cpp
View File

@ -48,15 +48,24 @@ DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP( SCH_EDIT_FRAME* aParent ) :
{ {
m_remapped = false; m_remapped = false;
if( !wxFileName::IsDirWritable( Prj().GetProjectPath() ) )
{
DisplayInfoMessage( this, _( "Remapping is not possible because you do not have "
"write privileges to the project folder \"%s\"." ) );
// Disable the remap button.
m_remapped = true;
}
wxString text; wxString text;
text = _( "This schematic currently uses the symbol library list look up method for " text = _( "This schematic currently uses the project symbol library list look up method "
"loading schematic symbols. KiCad will attempt to map the existing symbols " "for loading library symbols. KiCad will attempt to map the existing symbols "
"to use the new symbol library table. Remapping will change project files " "to use the new symbol library table. Remapping will change some project files "
"and schematics will not be compatible with previous versions of KiCad. " "and schematics may not be compatible with older versions of KiCad. All files "
"All files that are changed will be backed up with the .v4 extension should " "that are changed will be backed up to the \"remap_backup\" folder in the project "
"you need to revert any changes. If you choose to skip this step, you will " "folder should you need to revert any changes. If you choose to skip this step, "
"be responsible for manually remapping the symbols." ); "you will be responsible for manually remapping the symbols." );
m_htmlCtrl->AppendToPage( text ); m_htmlCtrl->AppendToPage( text );
} }
@ -70,7 +79,7 @@ void DIALOG_SYMBOL_REMAP::OnRemapSymbols( wxCommandEvent& aEvent )
wxBusyCursor busy; wxBusyCursor busy;
backupProject(); backupProject( m_messagePanel->Reporter() );
// Ignore the never show rescue setting for one last rescue of legacy symbol // Ignore the never show rescue setting for one last rescue of legacy symbol
// libraries before remapping to the symbol library table. This ensures the // libraries before remapping to the symbol library table. This ensures the
@ -292,43 +301,66 @@ bool DIALOG_SYMBOL_REMAP::remapSymbolToLibTable( SCH_COMPONENT* aSymbol )
} }
void DIALOG_SYMBOL_REMAP::backupProject() void DIALOG_SYMBOL_REMAP::backupProject( REPORTER& aReporter )
{ {
static wxString ext = "v4"; static wxString backupPath = "rescue-backup";
wxString tmp;
wxString errorMsg; wxString errorMsg;
wxFileName destFileName; wxFileName destFileName;
SCH_SCREENS schematic; SCH_SCREENS schematic;
// Copy backup files to different folder so as not to pollute the project folder.
destFileName.SetPath( Prj().GetProjectPath() );
destFileName.AppendDir( backupPath );
if( !destFileName.DirExists() )
{
if( !destFileName.Mkdir() )
{
errorMsg.Printf( _( "Cannot create project remap back up folder \"%s\"." ),
destFileName.GetPath() );
DisplayError( this, errorMsg );
return;
}
}
// Time stamp to append to file name in case multiple remappings are performed.
wxString timeStamp = wxDateTime::Now().Format( "-%Y-%m-%d-%H-%M-%S" );
// Back up the schematic files. // Back up the schematic files.
for( SCH_SCREEN* screen = schematic.GetFirst(); screen; screen = schematic.GetNext() ) for( SCH_SCREEN* screen = schematic.GetFirst(); screen; screen = schematic.GetNext() )
{ {
destFileName = screen->GetFileName(); destFileName = screen->GetFileName();
destFileName.SetName( destFileName.GetFullName() ); destFileName.SetName( destFileName.GetName() + timeStamp );
destFileName.SetExt( ext ); destFileName.AppendDir( backupPath );
wxLogTrace( "KICAD_TRACE_PATHS", "Backing up file '%s' to file '%s'.", tmp.Printf( _( "Backing up file \"%s\" to file \"%s\"." ),
screen->GetFileName(), destFileName.GetFullPath() ); screen->GetFileName(), destFileName.GetFullPath() );
aReporter.Report( tmp, REPORTER::RPT_INFO );
if( wxFileName::Exists( screen->GetFileName() ) if( wxFileName::Exists( screen->GetFileName() )
&& !wxCopyFile( screen->GetFileName(), destFileName.GetFullPath() ) ) && !wxCopyFile( screen->GetFileName(), destFileName.GetFullPath() ) )
{ {
errorMsg += wxPrintf( _( "Failed to back up file \"%s\".\n" ), screen->GetFileName() ); tmp.Printf( _( "Failed to back up file \"%s\".\n" ), screen->GetFileName() );
errorMsg += tmp;
} }
} }
// Back up the project file. // Back up the project file.
destFileName = Prj().GetProjectFullName(); destFileName = Prj().GetProjectFullName();
destFileName.SetName( destFileName.GetFullName() ); destFileName.SetName( destFileName.GetName() + timeStamp );
destFileName.SetExt( ext ); destFileName.AppendDir( backupPath );
wxLogTrace( "KICAD_TRACE_PATHS", "Backing up file \"%s\" to file \"%s\".", tmp.Printf( _( "Backing up file \"%s\" to file \"%s\"." ),
Prj().GetProjectFullName(), destFileName.GetFullPath() ); Prj().GetProjectFullName(), destFileName.GetFullPath() );
aReporter.Report( tmp, REPORTER::RPT_INFO );
if( wxFileName::Exists( Prj().GetProjectFullName() ) if( wxFileName::Exists( Prj().GetProjectFullName() )
&& !wxCopyFile( Prj().GetProjectFullName(), destFileName.GetFullPath() ) ) && !wxCopyFile( Prj().GetProjectFullName(), destFileName.GetFullPath() ) )
{ {
errorMsg += wxPrintf( _( "Failed to back up file \"%s\".\n" ), Prj().GetProjectFullName() ); tmp.Printf( _( "Failed to back up file \"%s\".\n" ), Prj().GetProjectFullName() );
errorMsg += tmp;
} }
wxFileName srcFileName; wxFileName srcFileName;
@ -339,43 +371,48 @@ void DIALOG_SYMBOL_REMAP::backupProject()
srcFileName.SetExt( SchematicLibraryFileExtension ); srcFileName.SetExt( SchematicLibraryFileExtension );
destFileName = srcFileName; destFileName = srcFileName;
destFileName.SetName( destFileName.GetFullName() ); destFileName.SetName( destFileName.GetName() + timeStamp );
destFileName.SetExt( ext ); destFileName.AppendDir( backupPath );
wxLogTrace( "KICAD_TRACE_PATHS", "Backing up file \"%s\" to file \"%s\".", tmp.Printf( _( "Backing up file \"%s\" to file \"%s\"." ),
srcFileName.GetFullPath(), destFileName.GetFullPath() ); srcFileName.GetFullPath(), destFileName.GetFullPath() );
aReporter.Report( tmp, REPORTER::RPT_INFO );
if( srcFileName.Exists() if( srcFileName.Exists()
&& !wxCopyFile( srcFileName.GetFullPath(), destFileName.GetFullPath() ) ) && !wxCopyFile( srcFileName.GetFullPath(), destFileName.GetFullPath() ) )
{ {
errorMsg += wxPrintf( _( "Failed to back up file \"%s\".\n" ), srcFileName.GetFullPath() ); tmp.Printf( _( "Failed to back up file \"%s\".\n" ), srcFileName.GetFullPath() );
errorMsg += tmp;
} }
// Back up the rescue library if it exists. // Back up the rescue library if it exists.
srcFileName.SetName( Prj().GetProjectName() + "-rescue" ); srcFileName.SetName( Prj().GetProjectName() + "-rescue" );
destFileName.SetName( srcFileName.GetFullName() ); destFileName.SetName( srcFileName.GetName() + timeStamp );
wxLogTrace( "KICAD_TRACE_PATHS", "Backing up file \"%s\" to file \"%s\".", tmp.Printf( _( "Backing up file \"%s\" to file \"%s\"." ),
srcFileName.GetFullPath(), destFileName.GetFullPath() ); srcFileName.GetFullPath(), destFileName.GetFullPath() );
aReporter.Report( tmp, REPORTER::RPT_INFO );
if( srcFileName.Exists() if( srcFileName.Exists()
&& !wxCopyFile( srcFileName.GetFullPath(), destFileName.GetFullPath() ) ) && !wxCopyFile( srcFileName.GetFullPath(), destFileName.GetFullPath() ) )
{ {
errorMsg += wxPrintf( _( "Failed to back up file \"%s\".\n" ), srcFileName.GetFullPath() ); tmp.Printf( _( "Failed to back up file \"%s\".\n" ), srcFileName.GetFullPath() );
errorMsg += tmp;
} }
// Back up the rescue library document file if it exists. // Back up the rescue library document file if it exists.
srcFileName.SetName( Prj().GetProjectName() + "-rescue" );
srcFileName.SetExt( "dcm" ); srcFileName.SetExt( "dcm" );
destFileName.SetName( srcFileName.GetFullName() ); destFileName.SetExt( srcFileName.GetExt() );
wxLogTrace( "KICAD_TRACE_PATHS", "Backing up file \"%s\" to file \"%s\".", tmp.Printf( _( "Backing up file \"%s\" to file \"%s\"." ),
srcFileName.GetFullPath(), destFileName.GetFullPath() ); srcFileName.GetFullPath(), destFileName.GetFullPath() );
aReporter.Report( tmp, REPORTER::RPT_INFO );
if( srcFileName.Exists() if( srcFileName.Exists()
&& !wxCopyFile( srcFileName.GetFullPath(), destFileName.GetFullPath() ) ) && !wxCopyFile( srcFileName.GetFullPath(), destFileName.GetFullPath() ) )
{ {
errorMsg += wxPrintf( _( "Failed to back up file \"%s\".\n" ), srcFileName.GetFullPath() ); tmp.Printf( _( "Failed to back up file \"%s\".\n" ), srcFileName.GetFullPath() );
errorMsg += tmp;
} }
if( !errorMsg.IsEmpty() ) if( !errorMsg.IsEmpty() )

20
eeschema/dialogs/dialog_symbol_remap.h
View File

@ -68,16 +68,22 @@ private:
bool remapSymbolToLibTable( SCH_COMPONENT* aSymbol ); bool remapSymbolToLibTable( SCH_COMPONENT* aSymbol );
/** /**
* Backup all of the files that could be modified by the remapping with a .v4 file extension * Backup all of the files that could be modified by the remapping with a time stamp
* in case something goes wrong. * appended to the file name into the "remap_backup" folder in case something goes wrong.
* *
* Backup the following: * Backup the following:
* - All schematic (*.sch -> *.sch.v4 ) files. * - All schematic (prj-name.sch -> remap_backup/prj-name-time-stamp.sch ) files.
* - The project (*.pro) -> *.pro.v4) file. * - The project (prj-name.pro) -> remap_backup/prj-name-time-stamp.pro) file.
* - The cache library (*-cache.lib -> *.-cache.lib.v4) file. * - The cache library (prj-name-cache.lib -> remap_backup/prj-name.-cache-time-stamp.lib)
* - The rescue library (*-rescue.lib -> *.rescue.lib.v4) file. * file.
* - The rescue library (prj-name-rescue.lib -> remap_backup/prj-name.rescue-time-stamp.lib)
* file.
* - The rescue library (prj-name-rescue.dcm -> remap_backup/prj-name.rescue-time-stamp.dcm)
* file.
*
* @param aReporter is the #REPORTER object in which to write information messages.
*/ */
void backupProject(); void backupProject( REPORTER& aReporter );
bool m_remapped; bool m_remapped;
}; };