From 1c52a602708fb464dc64f9d6cd812597c2a128de Mon Sep 17 00:00:00 2001 From: Mike Williams Date: Mon, 14 Aug 2023 10:36:18 -0400 Subject: [PATCH] Symbol Fields Table: API cleanups for non-modal window --- eeschema/fields_data_model.cpp | 60 ++++++++++++++++++---------------- eeschema/fields_data_model.h | 6 ++-- eeschema/sch_symbol.cpp | 12 +++++++ eeschema/sch_symbol.h | 2 ++ 4 files changed, 49 insertions(+), 31 deletions(-) diff --git a/eeschema/fields_data_model.cpp b/eeschema/fields_data_model.cpp index 5af17c8e49..cacc4dab14 100644 --- a/eeschema/fields_data_model.cpp +++ b/eeschema/fields_data_model.cpp @@ -22,22 +22,24 @@ void FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn( const wxString& aFieldName, const m_cols.push_back( { aFieldName, aLabel, aAddedByUser, false, false } ); for( unsigned i = 0; i < m_symbolsList.GetCount(); ++i ) - { if( SCH_SYMBOL* symbol = m_symbolsList[i].GetSymbol() ) - { - if( SCH_FIELD* field = symbol->GetFieldByName( aFieldName ) ) - m_dataStore[symbol->m_Uuid][aFieldName] = field->GetText(); - else if( isAttribute( aFieldName ) ) - m_dataStore[symbol->m_Uuid][aFieldName] = - getAttributeValue( m_symbolsList[i], aFieldName ); - // Handle fields with variables as names that are not present in the symbol - // by giving them the correct value - else if( IsTextVar( aFieldName ) ) - m_dataStore[symbol->m_Uuid][aFieldName] = aFieldName; - else - m_dataStore[symbol->m_Uuid][aFieldName] = wxEmptyString; - } - } + updateDataStoreSymbolField( *symbol, aFieldName ); +} + + +void FIELDS_EDITOR_GRID_DATA_MODEL::updateDataStoreSymbolField( const SCH_SYMBOL& aSymbol, + const wxString& aFieldName ) +{ + if( const SCH_FIELD* field = aSymbol.GetFieldByName( aFieldName ) ) + m_dataStore[aSymbol.m_Uuid][aFieldName] = field->GetText(); + else if( isAttribute( aFieldName ) ) + m_dataStore[aSymbol.m_Uuid][aFieldName] = getAttributeValue( aSymbol, aFieldName ); + // Handle fields with variables as names that are not present in the symbol + // by giving them the correct value + else if( IsTextVar( aFieldName ) ) + m_dataStore[aSymbol.m_Uuid][aFieldName] = aFieldName; + else + m_dataStore[aSymbol.m_Uuid][aFieldName] = wxEmptyString; } @@ -417,36 +419,36 @@ bool FIELDS_EDITOR_GRID_DATA_MODEL::isAttribute( const wxString& aFieldName ) } -wxString FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue( const SCH_REFERENCE& aRef, - const wxString& aAttributeName ) +wxString FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue( const SCH_SYMBOL& aSymbol, + const wxString& aAttributeName ) { if( aAttributeName == wxS( "${DNP}" ) ) - return aRef.GetSymbol()->GetDNP() ? wxS( "1" ) : wxS( "0" ); + return aSymbol.GetDNP() ? wxS( "1" ) : wxS( "0" ); if( aAttributeName == wxS( "${EXCLUDE_FROM_BOARD}" ) ) - return aRef.GetSymbol()->GetExcludedFromBoard() ? wxS( "1" ) : wxS( "0" ); + return aSymbol.GetExcludedFromBoard() ? wxS( "1" ) : wxS( "0" ); if( aAttributeName == wxS( "${EXCLUDE_FROM_BOM}" ) ) - return aRef.GetSymbol()->GetExcludedFromBOM() ? wxS( "1" ) : wxS( "0" ); + return aSymbol.GetExcludedFromBOM() ? wxS( "1" ) : wxS( "0" ); if( aAttributeName == wxS( "${EXCLUDE_FROM_SIM}" ) ) - return aRef.GetSymbol()->GetExcludedFromSim() ? wxS( "1" ) : wxS( "0" ); + return aSymbol.GetExcludedFromSim() ? wxS( "1" ) : wxS( "0" ); return wxS( "0" ); } -void FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue( const SCH_REFERENCE& aRef, - const wxString& aAttributeName, - const wxString& aValue ) +void FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue( SCH_SYMBOL& aSymbol, + const wxString& aAttributeName, + const wxString& aValue ) { if( aAttributeName == wxS( "${DNP}" ) ) - aRef.GetSymbol()->SetDNP( aValue == wxS( "1" ) ); + aSymbol.SetDNP( aValue == wxS( "1" ) ); else if( aAttributeName == wxS( "${EXCLUDE_FROM_BOARD}" ) ) - aRef.GetSymbol()->SetExcludedFromBoard( aValue == wxS( "1" ) ); + aSymbol.SetExcludedFromBoard( aValue == wxS( "1" ) ); else if( aAttributeName == wxS( "${EXCLUDE_FROM_BOM}" ) ) - aRef.GetSymbol()->SetExcludedFromBOM( aValue == wxS( "1" ) ); + aSymbol.SetExcludedFromBOM( aValue == wxS( "1" ) ); else if( aAttributeName == wxS( "${EXCLUDE_FROM_SIM}" ) ) - aRef.GetSymbol()->SetExcludedFromSim( aValue == wxS( "1" ) ); + aSymbol.SetExcludedFromSim( aValue == wxS( "1" ) ); } @@ -658,7 +660,7 @@ void FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData( // Attributes bypass the field logic, so handle them first if( isAttribute( srcName ) ) { - setAttributeValue( m_symbolsList[i], srcName, srcValue ); + setAttributeValue( *m_symbolsList[i].GetSymbol(), srcName, srcValue ); continue; } diff --git a/eeschema/fields_data_model.h b/eeschema/fields_data_model.h index c86b8ec6c6..1114d1351f 100644 --- a/eeschema/fields_data_model.h +++ b/eeschema/fields_data_model.h @@ -219,8 +219,8 @@ private: // Helper functions to deal with translating wxGrid values to and from // named field values like ${DNP} bool isAttribute( const wxString& aFieldName ); - wxString getAttributeValue( const SCH_REFERENCE& aRef, const wxString& aAttributeName ); - void setAttributeValue( const SCH_REFERENCE& aRef, const wxString& aAttributeName, + wxString getAttributeValue( const SCH_SYMBOL&, const wxString& aAttributeName ); + void setAttributeValue( SCH_SYMBOL& aSymbol, const wxString& aAttributeName, const wxString& aValue ); /* Helper function to get the resolved field value. @@ -231,6 +231,8 @@ private: void Sort(); + void updateDataStoreSymbolField( const SCH_SYMBOL& aSymbol, const wxString& aFieldName ); + protected: SCH_REFERENCE_LIST m_symbolsList; diff --git a/eeschema/sch_symbol.cpp b/eeschema/sch_symbol.cpp index 2c41fe5482..c98622bd2d 100644 --- a/eeschema/sch_symbol.cpp +++ b/eeschema/sch_symbol.cpp @@ -882,6 +882,18 @@ SCH_FIELD* SCH_SYMBOL::GetFieldByName( const wxString& aFieldName ) } +const SCH_FIELD* SCH_SYMBOL::GetFieldByName( const wxString& aFieldName ) const +{ + for( size_t ii = 0; ii < m_fields.size(); ++ii ) + { + if( m_fields[ii].GetName() == aFieldName ) + return &m_fields[ii]; + } + + return nullptr; +} + + wxString SCH_SYMBOL::GetFieldText( const wxString& aFieldName ) const { for( const SCH_FIELD& field : m_fields ) diff --git a/eeschema/sch_symbol.h b/eeschema/sch_symbol.h index df07af6ca7..3dcb1de69d 100644 --- a/eeschema/sch_symbol.h +++ b/eeschema/sch_symbol.h @@ -399,6 +399,8 @@ public: */ SCH_FIELD* GetFieldByName( const wxString& aFieldName ); + const SCH_FIELD* GetFieldByName( const wxString& aFieldName ) const; + /** * Search for a field named \a aFieldName and returns text associated with this field. *