realAscot/kicad-source
1
0
Fork 0
mirror of https://gitlab.com/kicad/code/kicad.git synced 2025-09-13 17:53:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve symbol fields table editor undo/redo memory usage.

Browse Source 
- Do not add a modify action to commit for symbols that have no changes.
- Do not add a modify action to commit for each instance of shared symbols.
This commit is contained in:
Wayne Stambaugh 2025-09-05 11:46:05 -04:00
parent c163f0a24c
commit 6f352ccd96
4 changed files with 118 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
eeschema/fields_data_model.cpp
View File

@ -728,18 +728,36 @@ wxString FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue( const SCH_SYMBOL& aSy
return wxS( "0" );
}
void FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue( SCH_SYMBOL& aSymbol,
bool FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue( SCH_SYMBOL& aSymbol,
const wxString& aAttributeName,
const wxString& aValue )
{
bool attrChanged = false;
bool newValue = aValue == wxS( "1" );
if( aAttributeName == wxS( "${DNP}" ) )
aSymbol.SetDNP( aValue == wxS( "1" ) );
{
attrChanged = aSymbol.GetDNP() != newValue;
aSymbol.SetDNP( newValue );
}
else if( aAttributeName == wxS( "${EXCLUDE_FROM_BOARD}" ) )
aSymbol.SetExcludedFromBoard( aValue == wxS( "1" ) );
{
attrChanged = aSymbol.GetExcludedFromBoard() != newValue;
aSymbol.SetExcludedFromBoard( newValue );
}
else if( aAttributeName == wxS( "${EXCLUDE_FROM_BOM}" ) )
aSymbol.SetExcludedFromBOM( aValue == wxS( "1" ) );
{
attrChanged = aSymbol.GetExcludedFromBOM() != newValue;
aSymbol.SetExcludedFromBOM( newValue );
}
else if( aAttributeName == wxS( "${EXCLUDE_FROM_SIM}" ) )
aSymbol.SetExcludedFromSim( aValue == wxS( "1" ) );
{
attrChanged = aSymbol.GetExcludedFromSim() != newValue;
aSymbol.SetExcludedFromSim( newValue );
}
return attrChanged;
}
@ -944,21 +962,28 @@ void FIELDS_EDITOR_GRID_DATA_MODEL::ExpandAfterSort()
void FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData( SCH_COMMIT& aCommit, TEMPLATES& aTemplateFieldnames )
{
bool symbolModified = false;
std::unique_ptr<SCH_SYMBOL> symbolCopy;
for( const SCH_REFERENCE& instance : m_symbolsList )
for( size_t i = 0; i < m_symbolsList.GetCount(); i++ )
{
SCH_SYMBOL& symbol = *instance.GetSymbol();
SCH_SYMBOL* symbol = m_symbolsList[i].GetSymbol();
SCH_SYMBOL* nextSymbol = nullptr;
aCommit.Modify( &symbol, instance.GetSheetPath().LastScreen() );
if( ( i + 1 ) < m_symbolsList.GetCount() )
nextSymbol = m_symbolsList[i + 1].GetSymbol();
const std::map<wxString, wxString>& fieldStore = m_dataStore[symbol.m_Uuid];
if( i == 0 )
symbolCopy = std::make_unique<SCH_SYMBOL>( *symbol );
const std::map<wxString, wxString>& fieldStore = m_dataStore[symbol->m_Uuid];
for( const auto& [srcName, srcValue] : fieldStore )
{
// Attributes bypass the field logic, so handle them first
if( isAttribute( srcName ) )
{
setAttributeValue( symbol, srcName, srcValue );
symbolModified |= setAttributeValue( *symbol, srcName, srcValue );
continue;
}
@ -967,7 +992,7 @@ void FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData( SCH_COMMIT& aCommit, TEMPLATES& a
if( IsGeneratedField( srcName ) )
continue;
SCH_FIELD* destField = symbol.GetField( srcName );
SCH_FIELD* destField = symbol->GetField( srcName );
if( destField && destField->IsPrivate() )
{
@ -985,15 +1010,16 @@ void FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData( SCH_COMMIT& aCommit, TEMPLATES& a
if( createField )
{
destField = symbol.AddField( SCH_FIELD( &symbol, FIELD_T::USER, srcName ) );
destField->SetTextAngle( symbol.GetField( FIELD_T::REFERENCE )->GetTextAngle() );
destField = symbol->AddField( SCH_FIELD( symbol, FIELD_T::USER, srcName ) );
destField->SetTextAngle( symbol->GetField( FIELD_T::REFERENCE )->GetTextAngle() );
if( const TEMPLATE_FIELDNAME* srcTemplate = aTemplateFieldnames.GetFieldName( srcName ) )
destField->SetVisible( srcTemplate->m_Visible );
else
destField->SetVisible( false );
destField->SetTextPos( symbol.GetPosition() );
destField->SetTextPos( symbol->GetPosition() );
symbolModified = true;
}
if( !destField )
@ -1005,16 +1031,38 @@ void FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData( SCH_COMMIT& aCommit, TEMPLATES& a
continue;
}
destField->SetText( symbol.Schematic()->ConvertRefsToKIIDs( srcValue ) );
wxString previousValue = destField->GetText();
destField->SetText( symbol->Schematic()->ConvertRefsToKIIDs( srcValue ) );
if( !createField && ( previousValue != srcValue ) )
symbolModified = true;
}
for( int ii = static_cast<int>( symbol.GetFields().size() ) - 1; ii >= 0; ii-- )
for( int ii = static_cast<int>( symbol->GetFields().size() ) - 1; ii >= 0; ii-- )
{
if( symbol.GetFields()[ii].IsMandatory() || symbol.GetFields()[ii].IsPrivate() )
if( symbol->GetFields()[ii].IsMandatory() || symbol->GetFields()[ii].IsPrivate() )
continue;
if( fieldStore.count( symbol.GetFields()[ii].GetName() ) == 0 )
symbol.GetFields().erase( symbol.GetFields().begin() + ii );
if( fieldStore.count( symbol->GetFields()[ii].GetName() ) == 0 )
{
symbol->GetFields().erase( symbol->GetFields().begin() + ii );
symbolModified = true;
}
}
if( symbolModified && ( symbol != nextSymbol ) )
aCommit.Modified( symbol, symbolCopy.release(), m_symbolsList[i].GetSheetPath().LastScreen() );
// Only reset the modified flag and next symbol copy if the next symbol is different from the current one.
if( symbol != nextSymbol )
{
if( nextSymbol )
symbolCopy = std::make_unique<SCH_SYMBOL>( *nextSymbol );
else
symbolCopy.reset( nullptr );
symbolModified = false;
}
}
@ -1206,6 +1254,8 @@ wxString FIELDS_EDITOR_GRID_DATA_MODEL::Export( const BOM_FMT_PRESET& settings )
void FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences( const SCH_REFERENCE_LIST& aRefs )
{
bool refListChanged = false;
for( const SCH_REFERENCE& ref : aRefs )
{
if( !m_symbolsList.Contains( ref ) )
@ -1225,8 +1275,13 @@ void FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences( const SCH_REFERENCE_LIST& aRe
m_dataStore[symbol->m_Uuid][name] = value;
}
}
refListChanged = true;
}
}
if( refListChanged )
m_symbolsList.SortBySymbolPtr();
}
@ -1267,6 +1322,8 @@ void FIELDS_EDITOR_GRID_DATA_MODEL::RemoveReferences( const SCH_REFERENCE_LIST&
void FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences( const SCH_REFERENCE_LIST& aRefs )
{
bool refListChanged = false;
for( const SCH_REFERENCE& ref : aRefs )
{
// Update the fields of every reference. Do this by iterating through the data model
@ -1276,6 +1333,12 @@ void FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences( const SCH_REFERENCE_LIST&
updateDataStoreSymbolField( *ref.GetSymbol(), col.m_fieldName );
if( !m_symbolsList.Contains( ref ) )
{
m_symbolsList.AddItem( ref );
refListChanged = true;
}
}
if( refListChanged )
m_symbolsList.SortBySymbolPtr();
}

18
eeschema/fields_data_model.h
View File

@ -339,7 +339,17 @@ private:
// named field values like ${DNP}
bool isAttribute( const wxString& aFieldName );
wxString getAttributeValue( const SCH_SYMBOL&, const wxString& aAttributeName );
void setAttributeValue( SCH_SYMBOL& aSymbol, const wxString& aAttributeName,
/**
* Set the attribute value.
*
* @param aSymbol is the symbol to set the attribute.
* @param aAttributeName is the name of the symbol attribute.
* @param aValue is the value to set the attribute.
* @retval true if the symbol attribute value has changed.
* @retval false if the symbol attribute has **not** changed.
*/
bool setAttributeValue( SCH_SYMBOL& aSymbol, const wxString& aAttributeName,
const wxString& aValue );
/* Helper function to get the resolved field value.
@ -355,6 +365,12 @@ private:
void updateDataStoreSymbolField( const SCH_SYMBOL& aSymbol, const wxString& aFieldName );
protected:
/**
* The flattened by hierarchy list of symbols.
*
* @warning This list **must** be kept sorted by symbol pointer. Otherwise, the undo/redo
* commit actions will be broken.
*/
SCH_REFERENCE_LIST m_symbolsList;
bool m_edited;
int m_sortColumn;

6
eeschema/sch_reference_list.cpp
View File

@ -156,6 +156,12 @@ bool SCH_REFERENCE_LIST::sortByTimeStamp( const SCH_REFERENCE& item1,
}
bool SCH_REFERENCE_LIST::sortBySymbolPtr( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 )
{
return item1.m_rootSymbol < item2.m_rootSymbol;
}
int SCH_REFERENCE_LIST::FindRefByFullPath( const wxString& aFullPath ) const
{
for( size_t i = 0; i < m_flatList.size(); ++i )

13
eeschema/sch_reference_list.h
View File

@ -526,6 +526,17 @@ public:
sort( m_flatList.begin(), m_flatList.end(), sortByReferenceOnly );
}
/**
* Sort the list by the symbol pointer.
*
* Because symbols are shared in complex hierarchies, this sorting can be used to coalesce symbol
* instance changes into a single commit instead of per instances commits.
*/
void SortBySymbolPtr()
{
sort( m_flatList.begin(), m_flatList.end(), sortBySymbolPtr );
}
/**
* Search the list for a symbol with a given reference.
*/
@ -620,6 +631,8 @@ private:
static bool sortByReferenceOnly( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
static bool sortBySymbolPtr( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
// Used for sorting static sortByTimeStamp function
friend class BACK_ANNOTATE;