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

Improve symbol instance data file save ordering. 

Use the root schematic UUID to order projects and sort symbol instance
data by KIID_PATH.  This will ensure file changes to instance data are
more consistent by using a fixed ordering.

Fixes https://gitlab.com/kicad/code/kicad/-/issues/17737
This commit is contained in:
Wayne Stambaugh 2024-04-20 08:57:00 -04:00
parent 95136494b3
commit a86a258f66
1 changed files with 52 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr.cpp
View File

@ -803,54 +803,62 @@ void SCH_IO_KICAD_SEXPR::saveSymbol( SCH_SYMBOL* aSymbol, const SCHEMATIC& aSche
if( !aSymbol->GetInstances().empty() ) if( !aSymbol->GetInstances().empty() )
{ {
std::map<KIID, std::vector<SCH_SYMBOL_INSTANCE>> projectInstances;
m_out->Print( aNestLevel + 1, "(instances\n" ); m_out->Print( aNestLevel + 1, "(instances\n" );
wxString projectName;
KIID lastProjectUuid; KIID lastProjectUuid;
KIID rootSheetUuid = aSchematic.Root().m_Uuid; KIID rootSheetUuid = aSchematic.Root().m_Uuid;
SCH_SHEET_LIST fullHierarchy = aSchematic.GetSheets(); SCH_SHEET_LIST fullHierarchy = aSchematic.GetSheets();
bool project_open = false;
for( size_t i = 0; i < aSymbol->GetInstances().size(); i++ ) for( const SCH_SYMBOL_INSTANCE& inst : aSymbol->GetInstances() )
{ {
// Zero length KIID_PATH objects are not valid and will cause a crash below. // Zero length KIID_PATH objects are not valid and will cause a crash below.
wxCHECK2( aSymbol->GetInstances()[i].m_Path.size(), continue ); wxCHECK2( inst.m_Path.size(), continue );
// If the instance data is part of this design but no longer has an associated sheet // If the instance data is part of this design but no longer has an associated sheet
// path, don't save it. This prevents large amounts of orphaned instance data for the // path, don't save it. This prevents large amounts of orphaned instance data for the
// current project from accumulating in the schematic files. // current project from accumulating in the schematic files.
// bool isOrphaned = ( inst.m_Path[0] == rootSheetUuid )
// Keep all instance data when copying to the clipboard. It may be needed on paste. && !fullHierarchy.GetSheetPathByKIIDPath( inst.m_Path );
if( !aForClipboard
&& ( aSymbol->GetInstances()[i].m_Path[0] == rootSheetUuid )
&& !fullHierarchy.GetSheetPathByKIIDPath( aSymbol->GetInstances()[i].m_Path ) )
{
if( project_open && ( ( i + 1 == aSymbol->GetInstances().size() )
|| lastProjectUuid != aSymbol->GetInstances()[i+1].m_Path[0] ) )
{
m_out->Print( aNestLevel + 2, ")\n" ); // Closes `project`.
project_open = false;
}
// Keep all instance data when copying to the clipboard. They may be needed on paste.
if( !aForClipboard && isOrphaned )
continue; continue;
auto it = projectInstances.find( inst.m_Path[0] );
if( it == projectInstances.end() )
{
projectInstances[ inst.m_Path[0] ] = { inst };
}
else
{
it->second.emplace_back( inst );
}
} }
if( lastProjectUuid != aSymbol->GetInstances()[i].m_Path[0] ) for( auto& [uuid, instances] : projectInstances )
{ {
wxString projectName; wxCHECK2( instances.size(), continue );
if( aSymbol->GetInstances()[i].m_Path[0] == rootSheetUuid ) // Sort project instances by KIID_PATH.
projectName = aSchematic.Prj().GetProjectName(); std::sort( instances.begin(), instances.end(),
else []( SCH_SYMBOL_INSTANCE& aLhs, SCH_SYMBOL_INSTANCE& aRhs )
projectName = aSymbol->GetInstances()[i].m_ProjectName; {
return aLhs.m_Path < aRhs.m_Path;
} );
projectName = instances[0].m_ProjectName;
lastProjectUuid = aSymbol->GetInstances()[i].m_Path[0];
m_out->Print( aNestLevel + 2, "(project %s\n", m_out->Print( aNestLevel + 2, "(project %s\n",
m_out->Quotew( projectName ).c_str() ); m_out->Quotew( projectName ).c_str() );
project_open = true;
}
for( const SCH_SYMBOL_INSTANCE& instance : instances )
{
wxString path; wxString path;
KIID_PATH tmp = aSymbol->GetInstances()[i].m_Path; KIID_PATH tmp = instance.m_Path;
if( aForClipboard && aRelativePath ) if( aForClipboard && aRelativePath )
tmp.MakeRelativeTo( aRelativePath->Path() ); tmp.MakeRelativeTo( aRelativePath->Path() );
@ -860,16 +868,12 @@ void SCH_IO_KICAD_SEXPR::saveSymbol( SCH_SYMBOL* aSymbol, const SCHEMATIC& aSche
m_out->Print( aNestLevel + 3, "(path %s\n", m_out->Print( aNestLevel + 3, "(path %s\n",
m_out->Quotew( path ).c_str() ); m_out->Quotew( path ).c_str() );
m_out->Print( aNestLevel + 4, "(reference %s) (unit %d)\n", m_out->Print( aNestLevel + 4, "(reference %s) (unit %d)\n",
m_out->Quotew( aSymbol->GetInstances()[i].m_Reference ).c_str(), m_out->Quotew( instance.m_Reference ).c_str(),
aSymbol->GetInstances()[i].m_Unit ); instance.m_Unit );
m_out->Print( aNestLevel + 3, ")\n" ); m_out->Print( aNestLevel + 3, ")\n" );
if( project_open && ( ( i + 1 == aSymbol->GetInstances().size() )
|| lastProjectUuid != aSymbol->GetInstances()[i+1].m_Path[0] ) )
{
m_out->Print( aNestLevel + 2, ")\n" ); // Closes `project`.
project_open = false;
} }
m_out->Print( aNestLevel + 2, ")\n" ); // Closes `project`.
} }
m_out->Print( aNestLevel + 1, ")\n" ); // Closes `instances`. m_out->Print( aNestLevel + 1, ")\n" ); // Closes `instances`.