symbol_fields_data_model.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#include <set>
 
#include <wx/string.h>
#include <wx/debug.h>
#include <wx/grid.h>
#include <wx/settings.h>
#include <common.h>
#include <widgets/wx_grid.h>
#include <sch_reference_list.h>
#include <sch_commit.h>
#include <sch_screen.h>
#include <template_fieldnames.h>
#include <sch_sheet_path.h>
#include "string_utils.h"
 
#include <symbol_fields_data_model.h>
 

KIID_PATH SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getDataStoreKey( const SCH_REFERENCE& aItem ) const
{
    KIID_PATH path = aItem.GetSheetPath().Path();
    path.push_back( aItem.GetSymbol()->m_Uuid );
    return path;
}
 
 
wxString SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getItemIdentifier( const SCH_REFERENCE& aItem ) const
{
    return aItem.GetRef() + aItem.GetRefNumber();
}
 
 
wxGridCellAttr* SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr( int aRow, int aCol, wxGridCellAttr::wxAttrKind aKind )
{
    wxGridCellAttr* attr = nullptr;
    bool            needsReadOnly = IsCellReadOnly( aRow, aCol );
    bool            needsUrlEditor = cellUsesUrlEditor( aRow, aCol );
    bool            needsVariantHighlight = false;
    bool            needsResolvedTextRenderer = cellUsesResolvedTextRenderer( aRow, aCol );
    wxColour        highlightColor;
 
    // Check if we need variant highlighting
    if( !m_currentVariant.IsEmpty() && aRow >= 0 && aRow < (int) m_rows.size() && aCol >= 0
        && aCol < (int) m_cols.size() )
    {
        const wxString& fieldName = m_cols[aCol].m_fieldName;
 
        // Skip Reference and generated fields (like ${QUANTITY}) for highlighting
        if( !ColIsReference( aCol ) && !ColIsQuantity( aCol ) && !ColIsItemNumber( aCol ) )
        {
            const SYMBOL_FIELDS_TABLE_DATA_MODEL_ROW& row = m_rows[aRow];
 
            // Check if any symbol in this row has a variant-specific value
            for( const SCH_REFERENCE& ref : row.m_items )
            {
                wxString defaultValue = getDefaultFieldValue( ref, fieldName );
 
                // Get the current value from the data store
                wxString currentValue;
 
                if( ref.GetSymbol() )
                    getStoredFieldValue( ref, fieldName, currentValue );
 
                if( currentValue != defaultValue )
                {
                    needsVariantHighlight = true;
 
                    bool isPriority2 = false;
 
                    if( const SCH_SYMBOL* sym = ref.GetSymbol() )
                    {
                        auto variantData = sym->GetVariant( ref.GetSheetPath(),
                                                            m_currentVariant );
 
                        if( variantData
                            && variantData->m_SymbolOverride
                            && !variantData->m_Fields.count( fieldName ) )
                        {
                            isPriority2 = true;
                        }
                    }
 
                    wxColour bg = wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW );
                    bool     isDark = ( bg.Red() + bg.Green() + bg.Blue() ) < 384;
 
                    if( isPriority2 )
                    {
                        highlightColor = isDark ? FIELDS_TABLE_COLOR::VARIANT_SYMBOL_OVERRIDE_DARK_BLUE
                                                : FIELDS_TABLE_COLOR::VARIANT_SYMBOL_OVERRIDE_LIGHT_BLUE;
                    }
                    else
                    {
                        highlightColor = isDark ? FIELDS_TABLE_COLOR::VARIANT_FIELD_OVERRIDE_DARK_YELLOW
                                                : FIELDS_TABLE_COLOR::VARIANT_FIELD_OVERRIDE_LIGHT_YELLOW;
                    }
 
                    break;
                }
            }
        }
    }
 
    // If we don't need any custom attributes, use the base class behavior
    if( !needsReadOnly && !needsUrlEditor && !needsVariantHighlight && !needsResolvedTextRenderer )
        return applyCellDecorations( WX_GRID_TABLE_BASE::GetAttr( aRow, aCol, aKind ), aRow, aCol );
 
    // URL cells use the Datasheet column's editor.  Other cells use their own column attributes.
    if( needsUrlEditor )
    {
        attr = cloneUrlEditorAttr();
    }
    else if( m_colAttrs.find( aCol ) != m_colAttrs.end() && m_colAttrs[aCol] )
    {
        attr = m_colAttrs[aCol]->Clone();
    }
    else
    {
        attr = new wxGridCellAttr();
    }
 
    if( needsReadOnly )
        attr->SetReadOnly();
 
    if( needsVariantHighlight )
        attr->SetBackgroundColour( highlightColor );
 
    if( needsResolvedTextRenderer )
        applyResolvedTextRenderer( attr, !needsVariantHighlight );
 
    return applyCellDecorations( enhanceAttr( attr, aRow, aCol, aKind ), aRow, aCol );
}
 
 
void SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::SetValue( int aRow, int aCol, const wxString& aValue )
{
    wxCHECK_RET( aCol >= 0 && aCol < static_cast<int>( m_cols.size() ), wxS( "Invalid column number" ) );
 
    if( IsCellReadOnly( aRow, aCol ) )
        return;
 
    if( aValue == INDETERMINATE_STATE )
        return;
 
    const SYMBOL_FIELDS_TABLE_DATA_MODEL_ROW& row = m_rows[aRow];
    const wxString&                           fieldName = m_cols[aCol].m_fieldName;
 
    std::set<const SCH_SYMBOL*> editedSymbols;
 
    for( const SCH_REFERENCE& ref : row.m_items )
        editedSymbols.insert( ref.GetSymbol() );
 
    // Field presence is on the symbol object and applies to all instances.
    // Before editing one path, ensure every instance for that symbol has this field
    // marked present at least.
    for( unsigned ii = 0; ii < m_symbolsList.GetCount(); ++ii )
    {
        const SCH_REFERENCE& ref = m_symbolsList[ii];
 
        if( !editedSymbols.contains( ref.GetSymbol() ) )
            continue;
 
        wxString unused;
 
        if( !getStoredFieldValue( ref, fieldName, unused ) )
        {
            updateDataStoreItemFieldFromLive( ref, fieldName );
 
            if( !getStoredFieldValue( ref, fieldName, unused ) )
                ensureStoredFieldPresent( ref, fieldName );
        }
    }
 
    for( const SCH_REFERENCE& ref : row.m_items )
        setStoredFieldValue( ref, fieldName, aValue );
 
    // ApplyData walks every path a symbol is reachable through, so an edit to storage those
    // paths have in common must also reach the ones the current scope and filter hide
    if( storageIsSharedAcrossPaths( fieldName ) )
    {
        for( unsigned ii = 0; ii < m_symbolsList.GetCount(); ++ii )
        {
            const SCH_REFERENCE& ref = m_symbolsList[ii];
 
            if( !editedSymbols.contains( ref.GetSymbol() ) )
                continue;
 
            setStoredFieldValue( ref, fieldName, aValue );
        }
    }
 
    m_edited = true;
}
 
 
void SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ClearCell( int aRow, int aCol )
{
    wxCHECK_RET( aRow >= 0 && aRow < static_cast<int>( m_rows.size() ), wxS( "Invalid row number" ) );
    wxCHECK_RET( aCol >= 0 && aCol < static_cast<int>( m_cols.size() ), wxS( "Invalid column number" ) );
 
    if( !CanClearCell( aRow, aCol ) )
        return;
 
    const wxString&             fieldName = m_cols[aCol].m_fieldName;
    std::set<const SCH_SYMBOL*> clearedSymbols;
 
    for( const SCH_REFERENCE& ref : m_rows[aRow].m_items )
        clearedSymbols.insert( ref.GetSymbol() );
 
    // Clearing a field is a symbol-wide operation, even when the table is showing one variant
    // or one instance of a shared sheet. Clear it from every data-store entry for the symbol so
    // a later entry cannot recreate it while ApplyData() walks the other instances.
    for( unsigned ii = 0; ii < m_symbolsList.GetCount(); ++ii )
    {
        const SCH_REFERENCE& ref = m_symbolsList[ii];
 
        if( clearedSymbols.contains( ref.GetSymbol() ) )
            clearStoredField( ref, fieldName );
    }
 
    m_edited = true;
}
 
 
void SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RevertRow( int aRow )
{
    wxCHECK_RET( aRow >= 0 && aRow < static_cast<int>( m_rows.size() ), wxS( "Invalid row number" ) );
 
    std::set<const SCH_SYMBOL*> rowSymbols;
 
    for( const SCH_REFERENCE& ref : m_rows[aRow].m_items )
        rowSymbols.insert( ref.GetSymbol() );
 
    for( const DATA_MODEL_COL& col : m_cols )
    {
        bool revertAllPaths = storageIsSharedAcrossPaths( col.m_fieldName );
 
        // Field presence belongs to the symbol rather than an individual path. If an edit added
        // or removed the field, restore every path so a hidden path cannot recreate it or retain
        // a pending creation when ApplyData() walks the symbol's other instances.
        if( !revertAllPaths )
        {
            for( unsigned ii = 0; ii < m_symbolsList.GetCount(); ++ii )
            {
                const SCH_REFERENCE& ref = m_symbolsList[ii];
 
                if( !rowSymbols.contains( ref.GetSymbol() ) )
                    continue;
 
                wxString liveValue;
                wxString storedValue;
                bool     liveFieldPresent = getLiveFieldValue( ref, col.m_fieldName, liveValue );
                bool     storedFieldPresent = getStoredFieldValue( ref, col.m_fieldName, storedValue );
 
                if( liveFieldPresent != storedFieldPresent )
                {
                    revertAllPaths = true;
                    break;
                }
            }
        }
 
        if( !revertAllPaths )
            continue;
 
        for( unsigned ii = 0; ii < m_symbolsList.GetCount(); ++ii )
        {
            const SCH_REFERENCE& ref = m_symbolsList[ii];
 
            if( rowSymbols.contains( ref.GetSymbol() ) )
                updateDataStoreItemFieldFromLive( ref, col.m_fieldName );
        }
    }
 
    FIELDS_TABLE_DATA_MODEL<SCH_REFERENCE>::RevertRow( aRow );
}
 
 
bool SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::unitMatch( const SCH_REFERENCE& lhItem, const SCH_REFERENCE& rhItem )
{
    // If items are unannotated then we can't tell if they're units of the same symbol or not
    if( lhItem.GetRefNumber() == wxT( "?" ) )
        return false;
 
    return ( lhItem.GetRef() == rhItem.GetRef() && lhItem.GetRefNumber() == rhItem.GetRefNumber() );
}
 
 
bool SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValue( const SCH_REFERENCE& aRef,
                                                              const wxString& aFieldName,
                                                              wxString& aValue )
{
    return getLiveFieldValueForVariant( aRef, aFieldName, m_currentVariant, aValue );
}
 
 
std::vector<SCH_REFERENCE> SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getAllItems() const
{
    std::vector<SCH_REFERENCE> items;
 
    for( unsigned i = 0; i < m_symbolsList.GetCount(); ++i )
    {
        if( m_symbolsList[i].GetSymbol() )
            items.push_back( m_symbolsList[i] );
    }
 
    return items;
}
 
 
wxString SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getFieldResolvedLiveValue( const SCH_REFERENCE& aRef,
                                                                          const wxString&      aFieldName )
{
    SCH_FIELD* field = aRef.GetSymbol()->GetField( aFieldName );
 
    if( field )
    {
        if( field->IsPrivate() )
            return wxEmptyString;
        else
            return field->GetShownText( &aRef.GetSheetPath(), INTERNAL, m_currentVariant );
    }
 
    // Handle generated fields with variables as names (e.g. ${QUANTITY}) that are not present in
    // the symbol by giving them the correct value by resolving against the symbol
    if( IsGeneratedField( aFieldName ) )
    {
        int                   depth = 0;
        const SCH_SHEET_PATH& path = aRef.GetSheetPath();
 
        std::function<bool( wxString* )> symbolResolver =
                [&]( wxString* token ) -> bool
                {
                    return aRef.GetSymbol()->ResolveTextVar( &path, token, m_currentVariant, depth + 1 );
                };
 
        return ResolveTextVars( aFieldName, &symbolResolver, depth );
    }
 
    return wxEmptyString;
}
 
 
wxString SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::resolveTextVars( const SCH_REFERENCE& aRef, const wxString& aText )
{
    // TODO: this isn't technically correct, this should resolve against the
    // data store's copy of variables whenever whenever possible,
    // but currently it is resolving against the symbol's current values.
    // For instance, if you have "My value is ${VALUE}" in the description field,
    // ${VALUE} will be resolved against the symbol's live value, not the Value field
    // stored in the data store.
    std::function<bool( wxString* )> symbolResolver =
            [&]( wxString* token ) -> bool
            {
                return aRef.GetSymbol()->ResolveTextVar( &aRef.GetSheetPath(), token, m_currentVariant );
            };
 
    int depth = 0;
    return ResolveTextVars( aText, &symbolResolver, depth );
}
 
 
bool SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::storageIsSharedAcrossPaths( const wxString& aFieldName ) const
{
    // Variant edits are kept on the symbol instance, but SCH_REFERENCE has no variant form of
    // the board exclusion so that one always lands on the symbol
    if( aFieldName == wxS( "${EXCLUDE_FROM_BOARD}" ) )
        return true;
 
    return m_currentVariant.IsEmpty();
}
 
 
wxString SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue( const SCH_REFERENCE& aRef,
                                                                  const wxString&      aAttributeName,
                                                                  const wxString&      aVariantName )
{
    if( aAttributeName == wxS( "${DNP}" ) )
        return aRef.GetSymbolDNP( aVariantName ) ? wxS( "1" ) : wxS( "0" );
 
    if( aAttributeName == wxS( "${EXCLUDE_FROM_BOARD}" ) )
        return aRef.GetSymbolExcludedFromBoard() ? wxS( "1" ) : wxS( "0" );
 
    if( aAttributeName == wxS( "${EXCLUDE_FROM_BOM}" ) )
        return aRef.GetSymbolExcludedFromBOM( aVariantName ) ? wxS( "1" ) : wxS( "0" );
 
    if( aAttributeName == wxS( "${EXCLUDE_FROM_SIM}" ) )
        return aRef.GetSymbolExcludedFromSim( aVariantName ) ? wxS( "1" ) : wxS( "0" );
 
    if( aAttributeName == wxS( "${EXCLUDE_FROM_POS_FILES}" ) )
        return aRef.GetSymbolExcludedFromPosFiles( aVariantName ) ? wxS( "1" ) : wxS( "0" );
 
    return wxS( "0" );
}
 
 
bool SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::attributeForcedOnBySheet( const SCH_REFERENCE& aRef,
                                                                     const wxString&      aAttributeName ) const
{
    const SCH_SHEET_PATH& path = aRef.GetSheetPath();
 
    if( aAttributeName == wxS( "${DNP}" ) )
        return path.GetDNP( m_currentVariant );
    else if( aAttributeName == wxS( "${EXCLUDE_FROM_BOARD}" ) )
        return path.GetExcludedFromBoard( m_currentVariant );
    else if( aAttributeName == wxS( "${EXCLUDE_FROM_BOM}" ) )
        return path.GetExcludedFromBOM( m_currentVariant );
    else if( aAttributeName == wxS( "${EXCLUDE_FROM_SIM}" ) )
        return path.GetExcludedFromSim( m_currentVariant );
 
    return false;
}
 
 
bool SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValueForVariant( const SCH_REFERENCE& aRef,
                                                                        const wxString&      aFieldName,
                                                                        const wxString& aVariantName, wxString& aValue )
{
    aValue.clear();
 
    const SCH_SYMBOL* symbol = aRef.GetSymbol();
 
    if( !symbol )
        return false;
 
    if( fieldIsAttribute( aFieldName ) )
    {
        aValue = getAttributeValue( aRef, aFieldName, aVariantName );
        return true;
    }
 
    if( const SCH_FIELD* field = symbol->GetField( aFieldName ) )
    {
        if( field->IsPrivate() )
            return false;
 
        aValue = symbol->Schematic()->ConvertKIIDsToRefs( field->GetText( &aRef.GetSheetPath(), aVariantName ) );
        return true;
    }
 
    // For generated fields, return the field name itself
    if( IsGeneratedField( aFieldName ) )
    {
        aValue = aFieldName;
        return true;
    }
 
    return false;
}
 
 
wxString SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getDefaultFieldValue( const SCH_REFERENCE& aRef,
                                                                     const wxString&      aFieldName )
{
    wxString value;
    getLiveFieldValueForVariant( aRef, aFieldName, wxEmptyString, value );
    return value;
}
 
 
bool SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue( SCH_REFERENCE&  aRef,
                                                       const wxString& aAttributeName,
                                                       const wxString& aValue,
                                                       const wxString& aVariantName )
{
    bool attrChanged = false;
    bool newValue = aValue == wxS( "1" );
 
    if( aAttributeName == wxS( "${DNP}" ) )
    {
        attrChanged = aRef.GetSymbolDNP( aVariantName ) != newValue;
 
        if( attrChanged )
            aRef.SetSymbolDNP( newValue, aVariantName );
    }
    else if( aAttributeName == wxS( "${EXCLUDE_FROM_BOARD}" ) )
    {
        attrChanged = aRef.GetSymbolExcludedFromBoard() != newValue;
 
        if( attrChanged )
            aRef.SetSymbolExcludedFromBoard( newValue );
    }
    else if( aAttributeName == wxS( "${EXCLUDE_FROM_BOM}" ) )
    {
        attrChanged = aRef.GetSymbolExcludedFromBOM( aVariantName ) != newValue;
 
        if( attrChanged )
            aRef.SetSymbolExcludedFromBOM( newValue, aVariantName );
    }
    else if( aAttributeName == wxS( "${EXCLUDE_FROM_SIM}" ) )
    {
        attrChanged = aRef.GetSymbolExcludedFromSim( aVariantName ) != newValue;
 
        if( attrChanged )
            aRef.SetSymbolExcludedFromSim( newValue, aVariantName );
    }
    else if( aAttributeName == wxS( "${EXCLUDE_FROM_POS_FILES}" ) )
    {
        attrChanged = aRef.GetSymbolExcludedFromPosFiles( aVariantName ) != newValue;
 
        if( attrChanged )
            aRef.SetSymbolExcludedFromPosFiles( newValue, aVariantName );
    }
 
    return attrChanged;
}
 
 
void SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows()
{
    if( !m_rebuildsEnabled )
        return;
 
    if( GetView() )
    {
        // Commit any pending in-place edits before the row gets moved out from under
        // the editor.
        static_cast<WX_GRID*>( GetView() )->CommitPendingChanges( true );
 
        wxGridTableMessage msg( this, wxGRIDTABLE_NOTIFY_ROWS_DELETED, 0, m_rows.size() );
        GetView()->ProcessTableMessage( msg );
    }
 
    m_rows.clear();
 
    EDA_COMBINED_MATCHER matcher( m_filter.Lower(), CTX_SEARCH );
 
    for( unsigned i = 0; i < m_symbolsList.GetCount(); ++i )
    {
        SCH_REFERENCE ref = m_symbolsList[i];
 
        if( m_scope == SCOPE::SCOPE_SELECTION
            && !m_selectionItems.contains( getDataStoreKey( ref ) ) )
        {
            continue;
        }
 
        if( !MatchesFilter( ref, ref.GetFullRef(), matcher ) )
            continue;
 
        if( m_excludeDNP )
        {
            bool isDNP = false;
 
            if( !m_variantNames.empty() )
            {
                for( const wxString& variantName : m_variantNames )
                {
                    if( ref.GetSymbol()->ResolveDNP( &ref.GetSheetPath(), variantName )
                        || ref.GetSheetPath().GetDNP( variantName ) )
                    {
                        isDNP = true;
                        break;
                    }
                }
            }
            else
            {
                isDNP = ref.GetSymbol()->ResolveDNP( &ref.GetSheetPath(), m_currentVariant )
                        || ref.GetSheetPath().GetDNP( m_currentVariant );
            }
 
            if( isDNP )
                continue;
        }
 
        if( !m_includeExcluded )
        {
            bool isExcluded = false;
 
            if( !m_variantNames.empty() )
            {
                for( const wxString& variantName : m_variantNames )
                {
                    if( ref.GetSymbol()->ResolveExcludedFromBOM( &ref.GetSheetPath(), variantName )
                        || ref.GetSheetPath().GetExcludedFromBOM( variantName ) )
                    {
                        isExcluded = true;
                        break;
                    }
                }
            }
            else
            {
                isExcluded = ref.GetSymbol()->ResolveExcludedFromBOM( &ref.GetSheetPath(), m_currentVariant )
                             || ref.GetSheetPath().GetExcludedFromBOM( m_currentVariant );
            }
 
            if( isExcluded )
                continue;
        }
 
        // Check if the symbol if on the current sheet or, in the sheet path somewhere
        // depending on scope
        if( ( m_scope == SCOPE::SCOPE_SHEET && ref.GetSheetPath() != m_path )
            || ( m_scope == SCOPE::SCOPE_SHEET_RECURSIVE
                 && !ref.GetSheetPath().IsContainedWithin( m_path ) ) )
        {
            continue;
        }
 
        bool matchFound = false;
 
        // Performance optimization for ungrouped case to skip the N^2 for loop
        if( !m_groupingEnabled && !ref.IsMultiUnit() )
        {
            m_rows.emplace_back( SYMBOL_FIELDS_TABLE_DATA_MODEL_ROW( ref, ROW_STATE::NON_EXPANDABLE ) );
            continue;
        }
 
        // See if we already have a row which this symbol fits into
        for( SYMBOL_FIELDS_TABLE_DATA_MODEL_ROW& row : m_rows )
        {
            // all group members must have identical refs so just use the first one
            SCH_REFERENCE rowRef = row.m_items[0];
 
            if( unitMatch( ref, rowRef ) )
            {
                matchFound = true;
                row.m_items.push_back( ref );
                break;
            }
            else if( m_groupingEnabled && groupMatch( ref, rowRef ) )
            {
                matchFound = true;
                row.m_items.push_back( ref );
                row.m_state = ROW_STATE::COLLAPSED;
                break;
            }
        }
 
        if( !matchFound )
            m_rows.emplace_back( SYMBOL_FIELDS_TABLE_DATA_MODEL_ROW( ref, ROW_STATE::NON_EXPANDABLE ) );
    }
 
    if( GetView() )
    {
        wxGridTableMessage msg( this, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, m_rows.size() );
        GetView()->ProcessTableMessage( msg );
    }
 
    Sort();
}
 
 
void SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData( SCH_COMMIT& aCommit, TEMPLATES& aTemplateFieldnames,
                                                      const wxString& aVariantName )
{
    bool                        symbolModified = false;
    std::unique_ptr<SCH_SYMBOL> symbolCopy;
 
    for( size_t i = 0; i < m_symbolsList.GetCount(); i++ )
    {
        SCH_SYMBOL* symbol = m_symbolsList[i].GetSymbol();
        SCH_SYMBOL* nextSymbol = nullptr;
 
        if( ( i + 1 ) < m_symbolsList.GetCount() )
            nextSymbol = m_symbolsList[i + 1].GetSymbol();
 
        if( i == 0 )
            symbolCopy = std::make_unique<SCH_SYMBOL>( *symbol );
 
        const std::map<wxString, wxString>& fieldStore = getStoredFields( m_symbolsList[i] );
 
        for( const auto& [srcName, srcValue] : fieldStore )
        {
            // Attributes bypass the field logic, so handle them first
            if( fieldIsAttribute( srcName ) )
            {
                symbolModified |= setAttributeValue( m_symbolsList[i], srcName, srcValue, aVariantName );
                continue;
            }
 
            // Skip generated fields with variables as names (e.g. ${QUANTITY});
            // they can't be edited
            if( IsGeneratedField( srcName ) )
                continue;
 
            SCH_FIELD* destField = symbol->GetField( srcName );
 
            if( destField && destField->IsPrivate() )
            {
                if( srcValue.IsEmpty() )
                    continue;
                else
                    destField->SetPrivate( false );
            }
 
            // Reaching this point means the data store field is at least marked present,
            // so add the field to the symbol even when its stored value is empty.
            bool createField = !destField;
 
            if( createField )
            {
                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() );
                symbolModified = true;
            }
 
            if( !destField )
                continue;
 
            // Reference is not editable from this dialog
            if( destField->GetId() == FIELD_T::REFERENCE )
                continue;
 
            wxString previousValue = destField->GetText( &m_symbolsList[i].GetSheetPath(), aVariantName );
 
            destField->SetText( symbol->Schematic()->ConvertRefsToKIIDs( srcValue ), &m_symbolsList[i].GetSheetPath(),
                                aVariantName );
 
            if( !createField && ( previousValue != srcValue ) )
                symbolModified = true;
        }
 
        for( int ii = static_cast<int>( symbol->GetFields().size() ) - 1; ii >= 0; ii-- )
        {
            if( symbol->GetFields()[ii].IsMandatory() || symbol->GetFields()[ii].IsPrivate() )
                continue;
 
            const wxString& existingName = symbol->GetFields()[ii].GetName();
 
            bool stillTracked = std::any_of( fieldStore.begin(), fieldStore.end(),
                                             [&]( const auto& kv )
                                             {
                                                 return kv.first == existingName;
                                             } );
 
            if( !stillTracked )
            {
                symbol->RemoveField( existingName );
                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;
        }
    }
 
    m_edited = false;
}
 
 
void SYMBOL_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 ) )
        {
            const SCH_REFERENCE* existingRef = nullptr;
 
            // A field belongs to the symbol object not reference, so an additional sheet path must have
            // the same field presence as the paths which already reach that symbol. Field values may
            // still differ by path when editing a variant.
            for( unsigned ii = 0; ii < m_symbolsList.GetCount(); ++ii )
            {
                if( m_symbolsList[ii].GetSymbol() == ref.GetSymbol() )
                {
                    existingRef = &m_symbolsList[ii];
                    break;
                }
            }
 
            if( existingRef )
            {
                for( const DATA_MODEL_COL& col : m_cols )
                {
                    wxString existingValue;
 
                    if( !getStoredFieldValue( *existingRef, col.m_fieldName, existingValue ) )
                        continue;
 
                    wxString value;
 
                    if( storageIsSharedAcrossPaths( col.m_fieldName ) )
                    {
                        value = existingValue;
                    }
                    else if( !getLiveFieldValue( ref, col.m_fieldName, value ) )
                    {
                        value.clear();
                    }
 
                    setStoredFieldValue( ref, col.m_fieldName, value );
                }
            }
            else
            {
                initializeDataStoreItem( ref );
            }
 
            m_symbolsList.AddItem( ref );
 
            refListChanged = true;
        }
    }
 
    if( refListChanged )
        m_symbolsList.SortBySymbolPtr();
}
 
 
void SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RemoveSymbol( const SCH_SYMBOL& aSymbol )
{
    // The schematic event listener passes us the symbol after it has been removed,
    // so we can't just work with a SCH_REFERENCE_LIST like the other handlers as the
    // references are already gone. Instead we need to prune our list.
 
    // Since we now use full KIID_PATH as keys, we need to find and remove all entries
    // that correspond to this symbol (their keys end with the symbol's UUID)
    KIID                   symbolUuid = aSymbol.m_Uuid;
    std::vector<KIID_PATH> keysToRemove;
 
    for( const auto& [key, value] : m_dataStore )
    {
        if( !key.empty() && ( key.back() == symbolUuid ) )
            keysToRemove.push_back( key );
    }
 
    for( const KIID_PATH& key : keysToRemove )
        m_dataStore.erase( key );
 
    // Remove all refs that match this symbol using remove_if
    m_symbolsList.erase( std::remove_if( m_symbolsList.begin(), m_symbolsList.end(),
                                         [&aSymbol]( const SCH_REFERENCE& ref ) -> bool
                                         {
                                             return ref.GetSymbol()->m_Uuid == aSymbol.m_Uuid;
                                         } ),
                         m_symbolsList.end() );
}
 
 
void SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RemoveReferences( const SCH_REFERENCE_LIST& aRefs )
{
    for( const SCH_REFERENCE& ref : aRefs )
    {
        int index = m_symbolsList.FindRefByFullPath( ref.GetFullPath() );
 
        if( index != -1 )
        {
            m_dataStore.erase( getDataStoreKey( ref ) );
            m_symbolsList.RemoveItem( index );
        }
    }
}
 
 
void SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences( const SCH_REFERENCE_LIST& aRefs )
{
    bool                  refListChanged = false;
    std::set<SCH_SYMBOL*> updatedSymbols;
 
    for( const SCH_REFERENCE& incomingRef : aRefs )
    {
        if( incomingRef.GetSymbol() )
            updatedSymbols.insert( incomingRef.GetSymbol() );
 
        SCH_REFERENCE* cachedRef = m_symbolsList.FindItem( incomingRef );
 
        // This looks like it might be assigning to itself because it often is
        if( cachedRef )
        {
            // When these things don't happen to be the same pointer, this will update our
            // cached reference's stuff like reference/unit/etc, but not the pointer to the symbol itself
            *cachedRef = incomingRef;
        }
        else
        {
            m_symbolsList.AddItem( incomingRef );
            refListChanged = true;
        }
    }
 
    if( refListChanged )
        m_symbolsList.SortBySymbolPtr();
 
    // Field presence is on the symbol object, so refresh every path/instance which reaches a
    // changed symbol even if the event supplied only one path.
    for( unsigned ii = 0; ii < m_symbolsList.GetCount(); ++ii )
    {
        const SCH_REFERENCE& ref = m_symbolsList[ii];
 
        if( !updatedSymbols.contains( ref.GetSymbol() ) )
            continue;
 
        initializeDataStoreItem( ref );
    }
}
 
 
bool SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::DeleteRows( size_t aPosition, size_t aNumRows )
{
    size_t curNumRows = m_rows.size();
 
    if( aPosition >= curNumRows )
    {
        wxFAIL_MSG( wxString::Format( wxT( "Called SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::DeleteRows(aPosition=%lu, "
                                           "aNumRows=%lu)\nPosition value is invalid for present table with %lu rows" ),
                                      (unsigned long) aPosition, (unsigned long) aNumRows,
                                      (unsigned long) curNumRows ) );
 
        return false;
    }
 
    if( aNumRows > curNumRows - aPosition )
    {
        aNumRows = curNumRows - aPosition;
    }
 
    if( aNumRows >= curNumRows )
    {
        m_rows.clear();
        m_dataStore.clear();
        m_symbolsList.Clear();
 
        if( GetView() )
        {
            wxGridTableMessage msg( this, wxGRIDTABLE_NOTIFY_ROWS_DELETED, aPosition, aNumRows );
            GetView()->ProcessTableMessage( msg );
        }
    }
    else
    {
        // Note: this code is currently dead, as all current usage calls the clear path above,
        // which is left because it is faster. This code *should* be correct but is untested.
        auto first = m_rows.begin() + aPosition;
        auto last = first + aNumRows;
 
        SCH_REFERENCE_LIST refsToDelete;
        for( auto it = first; it != last && it != m_rows.end(); ++it )
        {
            for( const SCH_REFERENCE& ref : it->m_items )
                refsToDelete.AddItem( ref );
        }
 
        RemoveReferences( refsToDelete );
        // This will also notify the view
        RebuildRows();
    }
 
    return true;
}
 
 
std::vector<FIELD_CASE_CONFLICT> DetectFieldCaseConflicts( const SCH_REFERENCE_LIST& aSymbols )
{
    std::vector<FIELD_CASE_CONFLICT> conflicts;
 
    for( unsigned i = 0; i < aSymbols.GetCount(); ++i )
    {
        SCH_SYMBOL* symbol = aSymbols[i].GetSymbol();
 
        if( !symbol )
            continue;
 
        std::map<wxString, std::vector<std::pair<wxString, wxString>>> groups;
 
        for( const SCH_FIELD& field : symbol->GetFields() )
        {
            if( field.IsMandatory() || field.IsPrivate() )
                continue;
 
            groups[field.GetName().Lower()].emplace_back( field.GetName(), field.GetText() );
        }
 
        for( const auto& [key, members] : groups )
        {
            if( members.size() < 2 )
                continue;
 
            FIELD_CASE_CONFLICT c;
            c.symbol = symbol;
            c.sheetPath = aSymbols[i].GetSheetPath();
            c.reference = symbol->GetRef( &c.sheetPath );
            c.caseFoldedKey = key;
            c.variants = members;
            conflicts.push_back( std::move( c ) );
        }
    }
 
    return conflicts;
}