symbol_fields_data_model.h

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/>.
 */
 
#pragma once
 
#include <fields_table_data_model.h>
#include <sch_reference_list.h>
 
 
class SCH_SYMBOL;
 
 
struct FIELD_CASE_CONFLICT
{
    SCH_SYMBOL*                                symbol;
    SCH_SHEET_PATH                             sheetPath;
    wxString                                   reference;
    wxString                                   caseFoldedKey;
    std::vector<std::pair<wxString, wxString>> variants;
};
 
 
std::vector<FIELD_CASE_CONFLICT> DetectFieldCaseConflicts( const SCH_REFERENCE_LIST& aSymbols );
 
using SYMBOL_FIELDS_TABLE_DATA_MODEL_ROW = DATA_MODEL_ROW<SCH_REFERENCE>;
 
class SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL : public FIELDS_TABLE_DATA_MODEL<SCH_REFERENCE>
{
public:
    enum SCOPE : int
    {
        SCOPE_ALL = 0,
        SCOPE_SHEET,
        SCOPE_SHEET_RECURSIVE,
        SCOPE_SELECTION
    };
 
    SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL( const SCH_REFERENCE_LIST& aSymbolsList ) :
            m_symbolsList( aSymbolsList ),
            m_scope( SCOPE_ALL )
    {
        m_symbolsList.SplitReferences();
    }
 
    wxGridCellAttr* GetAttr( int aRow, int aCol, wxGridCellAttr::wxAttrKind aKind ) override;
 
    void SetValue( int aRow, int aCol, const wxString& aValue ) override;
    void ClearCell( int aRow, int aCol ) override;
    void RevertRow( int aRow ) override;
 
    void RebuildRows() override;
 
    void ApplyData( SCH_COMMIT& aCommit, TEMPLATES& aTemplateFieldnames, const wxString& aVariantName );
 
    void  SetScope( SCOPE aScope ) { m_scope = aScope; }
    SCOPE GetScope() { return m_scope; }
 
    void                  SetPath( const SCH_SHEET_PATH& aPath ) { m_path = aPath; }
    const SCH_SHEET_PATH& GetPath() { return m_path; }
 
    void AddReferences( const SCH_REFERENCE_LIST& aRefs );
    void RemoveReferences( const SCH_REFERENCE_LIST& aRefs );
    void RemoveSymbol( const SCH_SYMBOL& aSymbol );
    void UpdateReferences( const SCH_REFERENCE_LIST& aRefs );
 
    bool DeleteRows( size_t aPosition = 0, size_t aNumRows = 1 ) override;
 
    const SCH_REFERENCE_LIST& GetReferenceList() const { return m_symbolsList; }
 
private:
    bool unitMatch( const SCH_REFERENCE& lhItem, const SCH_REFERENCE& rhItem ) override;

    bool storageIsSharedAcrossPaths( const wxString& aFieldName ) const;
 
    // True when an ancestor sheet forces this attribute on, not the symbol itself.
    bool attributeForcedOnBySheet( const SCH_REFERENCE& aRef, const wxString& aAttributeName ) const override;
 
    wxString getAttributeValue( const SCH_REFERENCE& aRef, const wxString& aAttributeName,
                                const wxString& aVariantNames );
    bool     getLiveFieldValueForVariant( const SCH_REFERENCE& aRef, const wxString& aFieldName,
                                          const wxString& aVariantName, wxString& aValue );

    wxString getDefaultFieldValue( const SCH_REFERENCE& aRef, const wxString& aFieldName );

    bool setAttributeValue( SCH_REFERENCE& aRef, const wxString& aAttributeName, const wxString& aValue,
                            const wxString& aVariantName = wxEmptyString );
 
    bool getLiveFieldValue( const SCH_REFERENCE& aRef, const wxString& aFieldName,
                            wxString& aValue ) override;
    std::vector<SCH_REFERENCE> getAllItems() const override;
 
    wxString getFieldResolvedLiveValue( const SCH_REFERENCE& aRef, const wxString& aFieldName ) override;
    wxString resolveTextVars( const SCH_REFERENCE& aRef, const wxString& aText ) override;
 
    KIID_PATH getDataStoreKey( const SCH_REFERENCE& aItem ) const override;
    wxString  getItemIdentifier( const SCH_REFERENCE& aItem ) const override;
 
protected:
    SCH_REFERENCE_LIST    m_symbolsList;
    SCOPE                 m_scope;
    SCH_SHEET_PATH        m_path;
};