sch_symbol.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2014 Dick Hollenbeck, [email protected]
 * Copyright (C) 2015 Wayne Stambaugh <[email protected]>
 * Copyright (C) 2022 CERN
 * 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 2
 * 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 <eda_item.h>
#include <core/typeinfo.h>
#include <layer_ids.h>
#include <lib_id.h>
 
#include <map>
#include <memory>
#include <string>
#include <unordered_map>
#include <vector>
#include <wx/arrstr.h>
#include <wx/chartype.h>
#include <wx/string.h>
 
#include <symbol.h>
#include <sch_field.h>
#include <sch_pin.h>
#include <sch_sheet_path.h>    // SCH_SYMBOL_INSTANCE
#include <transform.h>
 
struct PICKED_SYMBOL;
class KIID_PATH;
class SCH_SCREEN;
class LIB_SYMBOL;
class MSG_PANEL_ITEM;
class LEGACY_SYMBOL_LIB;
class LEGACY_SYMBOL_LIBS;
class SCH_SCREEN;
class SCH_COMMIT;
class SCH_SHAPE;
class SCH_SYMBOL_FIELD_PROPERTY;
 
 
namespace kiapi::schematic::types
{
class SchematicSymbolInstance;
}
 
 
typedef std::weak_ptr<LIB_SYMBOL> PART_REF;
 
 
extern std::string toUTFTildaText( const wxString& txt );
 

class SCH_SYMBOL : public SYMBOL
{
public:
    SCH_SYMBOL();

    SCH_SYMBOL( const LIB_SYMBOL& aSymbol, const LIB_ID& aLibId, const SCH_SHEET_PATH* aSheet,
                int aUnit, int aBodyStyle = 0, const VECTOR2I& aPosition = VECTOR2I( 0, 0 ),
                EDA_ITEM* aParent = nullptr );
 
    SCH_SYMBOL( const LIB_SYMBOL& aSymbol, const SCH_SHEET_PATH* aSheet, const PICKED_SYMBOL& aSel,
                const VECTOR2I& aPosition = VECTOR2I( 0, 0 ), EDA_ITEM* aParent = nullptr );

    SCH_SYMBOL( const SCH_SYMBOL& aSymbol );
 
    ~SCH_SYMBOL();
 
    static inline bool ClassOf( const EDA_ITEM* aItem )
    {
        return aItem && SCH_SYMBOL_T == aItem->Type();
    }
 
    wxString GetClass() const override
    {
        return wxT( "SCH_SYMBOL" );
    }

    bool IsMissingLibSymbol() const;
 
    const std::vector<SCH_SYMBOL_INSTANCE>& GetInstances() const
    {
        return m_instances;
    }
 
    bool GetInstance( SCH_SYMBOL_INSTANCE& aInstance,
                      const KIID_PATH& aSheetPath, bool aTestFromEnd = false ) const;
 
    void RemoveInstance( const SCH_SHEET_PATH& aInstancePath );
 
    void RemoveInstance( const KIID_PATH& aInstancePath );

    bool IsMovableFromAnchorPoint() const override;
 
    void SetLibId( const LIB_ID& aName );
 
    const LIB_ID& GetLibId() const override { return m_lib_id; }
 
    wxString GetSymbolIDAsString() const { return m_lib_id.Format(); }

    void SetSchSymbolLibraryName( const wxString& aName ) { m_schLibSymbolName = aName; }
    wxString GetSchSymbolLibraryName() const;
    bool UseLibIdLookup() const { return m_schLibSymbolName.IsEmpty(); }
 
    std::unique_ptr< LIB_SYMBOL >& GetLibSymbolRef() { return m_part; }
    const std::unique_ptr< LIB_SYMBOL >& GetLibSymbolRef() const { return m_part; }
 
    bool HasEffectiveAssociatedFootprint() const;

    void SetLibSymbol( LIB_SYMBOL* aLibSymbol );

    wxString GetDescription() const override;
    wxString GetShownDescription( RESOLUTION_CONTEXT aContext, int aDepth = 0 ) const override;

    wxString GetKeyWords() const override;
    wxString GetShownKeyWords( RESOLUTION_CONTEXT aContext, int aDepth = 0 ) const override;

    wxString GetDatasheet() const;

    void UpdatePins();

    wxString GetUnitDisplayName( int aUnit, bool aLabel ) const override;
 
    wxString GetBodyStyleDescription( int aBodyStyle, bool aLabel ) const override;
 
    void SetBodyStyle( int aBodyStyle ) override;
 
    wxString GetPrefix() const { return m_prefix; }
    void SetPrefix( const wxString& aPrefix ) { m_prefix = aPrefix; }

    void UpdatePrefix();
 
    wxString SubReference( int aUnit, bool aAddSeparator = true ) const;

    int GetUnitCount() const override;
 
    bool IsMultiUnit() const override { return GetUnitCount() > 1; }

    int GetBodyStyleCount() const override;
 
    bool IsMultiBodyStyle() const override { return GetBodyStyleCount() > 1; }
 
    bool HasDeMorganBodyStyles() const override;

    void SetOrientation( int aOrientation );

    int GetOrientation() const override;

    void SetOrientationProp( SYMBOL_ORIENTATION_PROP aAngle )
    {
        int mirroring = GetOrientation();
 
        mirroring &= ( SYMBOL_ORIENTATION_T::SYM_MIRROR_X | SYMBOL_ORIENTATION_T::SYM_MIRROR_Y );
 
        SetOrientation( aAngle | mirroring );
    }
 
    SYMBOL_ORIENTATION_PROP GetOrientationProp() const
    {
        int orientation = GetOrientation();
 
        orientation &= ~( SYMBOL_ORIENTATION_T::SYM_MIRROR_X | SYMBOL_ORIENTATION_T::SYM_MIRROR_Y );
 
        switch( orientation )
        {
        default:
        case SYM_NORMAL:
        case SYM_ORIENT_0:   return SYMBOL_ORIENTATION_PROP::SYMBOL_ANGLE_0;
        case SYM_ORIENT_90:  return SYMBOL_ORIENTATION_PROP::SYMBOL_ANGLE_90;
        case SYM_ORIENT_180: return SYMBOL_ORIENTATION_PROP::SYMBOL_ANGLE_180;
        case SYM_ORIENT_270: return SYMBOL_ORIENTATION_PROP::SYMBOL_ANGLE_270;
        }
    }
 
    void SetMirrorX( bool aMirror )
    {
        int orientation = GetOrientation();
 
        if( aMirror )
            orientation |= SYMBOL_ORIENTATION_T::SYM_MIRROR_X;
        else
            orientation &= ~SYMBOL_ORIENTATION_T::SYM_MIRROR_X;
 
        SetOrientation( orientation );
    }
 
    bool GetMirrorX() const
    {
        return GetOrientation() & SYMBOL_ORIENTATION_T::SYM_MIRROR_X;
    }
 
    void SetMirrorY( bool aMirror )
    {
        int orientation = GetOrientation();
 
        if( aMirror )
            orientation |= SYMBOL_ORIENTATION_T::SYM_MIRROR_Y;
        else
            orientation &= ~SYMBOL_ORIENTATION_T::SYM_MIRROR_Y;
 
        SetOrientation( orientation );
    }
 
    bool GetMirrorY() const
    {
        return GetOrientation() & SYMBOL_ORIENTATION_T::SYM_MIRROR_Y;
    }

    void GetContextualTextVars( wxArrayString* aVars ) const;

    bool ResolveTextVar( const SCH_SHEET_PATH* aPath, wxString* token, int aDepth = 0 ) const;

    bool ResolveTextVar( const SCH_SHEET_PATH* aPath, wxString* token,
                         const wxString& aVariantName, int aDepth = 0 ) const;
 
    void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;

    void ClearAnnotation( const SCH_SHEET_PATH* aSheetPath, bool aResetPrefix );

    bool AddSheetPathReferenceEntryIfMissing( const KIID_PATH& aSheetPath );

    bool SetInstanceProjectName( const KIID_PATH& aSheetPath, const wxString& aProjectName );
 
 
    const BOX2I GetBoundingBox() const override;

    BOX2I GetBodyBoundingBox() const override;

    BOX2I GetBodyAndPinsBoundingBox() const override;
 
 
    //-----<Fields>-----------------------------------------------------------

    SCH_FIELD* GetField( FIELD_T aFieldType );
    const SCH_FIELD* GetField( FIELD_T aFieldNdx ) const;

    SCH_FIELD* GetField( const wxString& aFieldName );
    const SCH_FIELD* GetField( const wxString& aFieldName ) const;

    void GetFields( std::vector<SCH_FIELD*>& aVector, bool aVisibleOnly ) const override;

    std::vector<SCH_FIELD>& GetFields() { return m_fields; }
    const std::vector<SCH_FIELD>& GetFields() const { return m_fields; }
 
    std::vector<PROPERTY_BASE*> GetDynamicProperties() const override;
    std::vector<PROPERTY_BASE*> GetDynamicProperties( const SCH_SHEET_PATH* aPath ) const;

    SCH_FIELD* AddField( const SCH_FIELD& aField );

    void RemoveField( const wxString& aFieldName );
 
    void RemoveField( SCH_FIELD* aField )
    {
        if( aField )
            RemoveField( aField->GetName() );
    }

    SCH_FIELD*       FindFieldCaseInsensitive( const wxString& aFieldName );
    const SCH_FIELD* FindFieldCaseInsensitive( const wxString& aFieldName ) const;

    const wxString GetRef( const SCH_SHEET_PATH* aSheet,
                           bool aIncludeUnit = false ) const override;

    const wxString GetValue( const SCH_SHEET_PATH* aPath, RESOLUTION_CONTEXT aContext,
                             const wxString& aVariantName = wxEmptyString ) const override;
 
    void SetValueFieldText( const wxString& aValue, const SCH_SHEET_PATH* aInstance = nullptr,
                            const wxString& aVariantName = wxEmptyString );
 
    const wxString GetFootprintFieldText( const SCH_SHEET_PATH* aPath, RESOLUTION_CONTEXT aContext,
                                          const wxString& aVariantName = wxEmptyString ) const;
    void SetFootprintFieldText( const wxString& aFootprint );
 
    /*
     * Field access for property manager
     */
    wxString GetRefProp() const;
 
    void SetRefProp( const wxString& aRef );
 
    wxString GetValueProp() const;
 
    void SetValueProp( const wxString& aValue );  // Implemented in sch_symbol.cpp for tracing
 
    int GetUnitProp() const;
 
    void SetFieldText( SCH_FIELD* aField, const wxString& aFieldName, const wxString& aFieldText,
                       const SCH_SHEET_PATH* aPath, const wxString& aVariantName );
 
    void SetFieldText( const wxString& aFieldName, const wxString& aFieldText, const SCH_SHEET_PATH* aPath = nullptr,
                       const wxString& aVariantName = wxEmptyString );
 
    wxString GetFieldText( const SCH_FIELD* aField, const wxString& aFieldName, const SCH_SHEET_PATH* aPath,
                           const wxString& aVariantName ) const;
 
    wxString GetFieldText( const wxString& aFieldName, const SCH_SHEET_PATH* aPath = nullptr,
                           const wxString& aVariantName = wxEmptyString ) const;
 
    void SetUnitProp( int aUnit );
 
    wxString GetBodyStyleProp() const override
    {
        return GetBodyStyleDescription( GetBodyStyle(), false );
    }
 
    void SetBodyStyleProp( const wxString& aBodyStyle ) override
    {
        for( int bodyStyle = 1; bodyStyle <= GetBodyStyleCount(); bodyStyle++ )
        {
            if( GetBodyStyleDescription( bodyStyle, false ) == aBodyStyle )
            {
                SetBodyStyle( bodyStyle );
                return;
            }
        }
    }

    void UpdateFields( const SCH_SHEET_PATH* aPath, bool aUpdateStyle, bool aUpdateRef,
                       bool aUpdateOtherFields, bool aResetRef, bool aResetOtherFields );

    void SyncOtherUnits( const SCH_SHEET_PATH& aSourceSheet, SCH_COMMIT& aCommit,
                         PROPERTY_BASE* aProperty,
                         const wxString& aVariantName = wxEmptyString );

    int GetNextFieldOrdinal() const;

    void AutoplaceFields( SCH_SCREEN* aScreen, AUTOPLACE_ALGO aAlgo ) override;
 
    void RunOnChildren( const std::function<void( SCH_ITEM* )>& aFunction, RECURSE_MODE aMode ) override;
 
    void ClearCaches() override;
 
    //-----</Fields>----------------------------------------------------------
 

    SCH_PIN* GetPin( const wxString& number ) const;

    SCH_PIN* GetPinByEffectivePadNumber( const wxString& aPadNumber, const SCH_SHEET_PATH* aSheet,
                                         const wxString& aVariantName = wxEmptyString ) const;

    std::vector<SCH_PIN*> GetPinsByNumber( const wxString& aNumber ) const;

    std::vector<SCH_PIN*> GetLibPins() const;

    std::vector<SCH_PIN*> GetAllLibPins() const;

    size_t GetFullPinCount() const;

    SCH_PIN* GetPin( SCH_PIN* aLibPin ) const;

    const SCH_PIN* GetPin( const VECTOR2I& aPosition ) const;

    std::vector<const SCH_PIN*> GetPins( const SCH_SHEET_PATH* aSheet ) const;
    std::vector<SCH_PIN*> GetPins( const SCH_SHEET_PATH* aSheet );
 
    std::vector<SCH_PIN*> GetGraphicalPins( int aUnit, int aBodyStyle ) const override;
 
 
    std::vector<std::unique_ptr<SCH_PIN>>& GetRawPins() { return m_pins; }
    const std::vector<std::unique_ptr<SCH_PIN>>& GetRawPins() const { return m_pins; }

    void SetRef( const SCH_SHEET_PATH* aSheet, const wxString& aReference );

    bool IsAnnotated( const SCH_SHEET_PATH* aSheet ) const;

    void AddHierarchicalReference( const KIID_PATH& aPath,
                                   const wxString&  aRef,
                                   int              aUnit );
 
    void AddHierarchicalReference( const SCH_SYMBOL_INSTANCE& aInstance );

    int GetUnitSelection( const SCH_SHEET_PATH* aSheet ) const;

    void SetUnitSelection( const SCH_SHEET_PATH* aSheet, int aUnitSelection );

    void SetUnitSelection( int aUnitSelection );
 
    virtual void SetDNP( bool aEnable, const SCH_SHEET_PATH* aInstance = nullptr,
                         const wxString& aVariantName = wxEmptyString ) override;
    virtual bool GetDNP( const SCH_SHEET_PATH* aInstance = nullptr,
                         const wxString& aVariantName = wxEmptyString ) const override;
 
    bool GetDNPProp() const;
 
    void SetDNPProp( bool aEnable );

    void SetPinMapOverride( const PIN_MAP_INSTANCE_OVERRIDE& aOverride, const SCH_SHEET_PATH* aInstance = nullptr,
                            const wxString& aVariantName = wxEmptyString );

    PIN_MAP_INSTANCE_OVERRIDE GetPinMapOverride( const SCH_SHEET_PATH* aInstance = nullptr,
                                                 const wxString&       aVariantName = wxEmptyString ) const;

    void ClearPinMapOverrides();
 
    void SetExcludedFromBOM( bool aEnable, const SCH_SHEET_PATH* aInstance = nullptr,
                             const wxString& aVariantName = wxEmptyString ) override;
    bool GetExcludedFromBOM( const SCH_SHEET_PATH* aInstance = nullptr,
                             const wxString& aVariantName = wxEmptyString ) const override;
 
    bool GetExcludedFromBOMProp() const;
 
    void SetExcludedFromBOMProp( bool aEnable );
 
    void SetExcludedFromSim( bool aEnable, const SCH_SHEET_PATH* aInstance = nullptr,
                             const wxString& aVariantName = wxEmptyString ) override;
    bool GetExcludedFromSim( const SCH_SHEET_PATH* aInstance = nullptr,
                             const wxString& aVariantName = wxEmptyString ) const override;
 
    bool GetExcludedFromSimProp() const;
 
    void SetExcludedFromSimProp( bool aEnable );
 
    void SetExcludedFromBoard( bool aEnable, const SCH_SHEET_PATH* aInstance = nullptr,
                               const wxString& aVariantName = wxEmptyString ) override;
    bool GetExcludedFromBoard( const SCH_SHEET_PATH* aInstance = nullptr,
                               const wxString& aVariantName = wxEmptyString ) const override;
 
    bool GetExcludedFromBoardProp() const;
 
    void SetExcludedFromBoardProp( bool aEnable );
 
    void SetExcludedFromPosFiles( bool aEnable, const SCH_SHEET_PATH* aInstance = nullptr,
                                  const wxString& aVariantName = wxEmptyString ) override;
    bool GetExcludedFromPosFiles( const SCH_SHEET_PATH* aInstance = nullptr,
                                  const wxString& aVariantName = wxEmptyString ) const override;
 
    bool GetExcludedFromPosFilesProp() const;
 
    void SetExcludedFromPosFilesProp( bool aEnable );

    EMBEDDED_FILES* GetEmbeddedFiles() override;
 
    void Move( const VECTOR2I& aMoveVector ) override
    {
        if( aMoveVector == VECTOR2I( 0, 0 ) )
            return;
 
        m_pos += aMoveVector;
 
        for( SCH_FIELD& field : m_fields )
            field.Move( aMoveVector );
    }
 
    void MirrorHorizontally( int aCenter ) override;
    void MirrorVertically( int aCenter ) override;
    void Rotate( const VECTOR2I& aCenter, bool aRotateCCW ) override;
 
    bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const override;
 
    void GetEndPoints( std::vector<DANGLING_END_ITEM>& aItemList ) override;

    bool UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemListByType,
                              std::vector<DANGLING_END_ITEM>& aItemListByPos,
                              const SCH_SHEET_PATH*           aPath = nullptr ) override;
 
    VECTOR2I GetPinPhysicalPosition( const SCH_PIN* Pin ) const;
 
    bool IsConnectable() const override { return true; }
 
    bool HasConnectivityChanges( const SCH_ITEM* aItem,
                                 const SCH_SHEET_PATH* aInstance = nullptr ) const override;
 
    bool CanConnect( const SCH_ITEM* aItem ) const override
    {
        return ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_WIRE ) ||
               ( aItem->Type() == SCH_NO_CONNECT_T ) ||
               ( aItem->Type() == SCH_JUNCTION_T ) ||
               ( aItem->Type() == SCH_SYMBOL_T ) ||
               ( aItem->Type() == SCH_DIRECTIVE_LABEL_T ) ||
               ( aItem->Type() == SCH_LABEL_T ) ||
               ( aItem->Type() == SCH_HIER_LABEL_T ) ||
               ( aItem->Type() == SCH_GLOBAL_LABEL_T );
    }

    bool DoNetList() const;
 
    enum class PASSTHROUGH_MODE
    {
        DEFAULT,
        BLOCK,
        FORCE
    };
 
    PASSTHROUGH_MODE GetPassthroughMode() const { return m_passthroughMode; }
    void SetPassthroughMode( PASSTHROUGH_MODE aMode )
    {
        if( m_passthroughMode != aMode )
        {
            m_passthroughMode = aMode;
            SetConnectivityDirty();
        }
    }
 
    const wxString& GetNetChainName() const { return m_signalName; }
    void SetNetChainName( wxString aName ) noexcept { m_signalName.swap( aName ); }
 
    std::vector<VECTOR2I> GetConnectionPoints() const override;
 
    INSPECT_RESULT Visit( INSPECTOR inspector, void* testData,
                          const std::vector<KICAD_T>& aScanTypes ) override;

    SCH_ITEM* GetDrawItem( const VECTOR2I& aPosition, KICAD_T aType = TYPE_NOT_INIT );
 
    wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
 
    BITMAPS GetMenuImage() const override;
 
    bool operator <( const SCH_ITEM& aItem ) const override;
 
    bool operator==( const SCH_SYMBOL& aSymbol) const;
    bool operator!=( const SCH_SYMBOL& aSymbol) const;
 
    SCH_SYMBOL& operator=( const SCH_SYMBOL& aItem );
 
    bool IsReplaceable() const override { return true; }
 
    VECTOR2I GetPosition() const override { return m_pos; }
    void    SetPosition( const VECTOR2I& aPosition ) override { Move( aPosition - m_pos ); }
 
    int GetX() const { return GetPosition().x; };
    void SetX( int aX ) { SetPosition( VECTOR2I( aX, GetY() ) ); }
 
    int GetY() const { return GetPosition().y; }
    void SetY( int aY ) { SetPosition( VECTOR2I( GetX(), aY ) ); }
 
    bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
    bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
    bool HitTest( const SHAPE_LINE_CHAIN& aPoly, bool aContained ) const override;
 
    void Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts,
               int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed ) override;

    void PlotPins( PLOTTER* aPlotter, bool aDnp ) const;

    void PlotLocalPowerIconShape( PLOTTER* aPlotter ) const;

    void PlotDNP( PLOTTER* aPlotter ) const;

    static void BuildLocalPowerIconShape( std::vector<SCH_SHAPE>& aShapeList, const VECTOR2D& aPos,
                                          double aSize, double aLineWidth, bool aHorizontal );
 
    EDA_ITEM* Clone() const override;
 
    void Serialize( google::protobuf::Any& aContainer ) const override;
    bool Deserialize( const google::protobuf::Any& aContainer ) override;
 
    void Serialize( kiapi::schematic::types::SchematicSymbolInstance& aSymbol ) const;
    bool Deserialize( const kiapi::schematic::types::SchematicSymbolInstance& aSymbol );
 
#if defined(DEBUG)
    void Show( int nestLevel, std::ostream& os ) const override;
#endif
 
    void ClearBrightenedPins();
 
    bool HasBrightenedPins();
 
    bool IsPointClickableAnchor( const VECTOR2I& aPos ) const override;

    bool IsSymbolLikePowerGlobalLabel() const;
    bool IsSymbolLikePowerLocalLabel() const;
 
    bool IsGlobalPower() const override;
    bool IsLocalPower() const override;
    bool IsPower() const override;
    bool IsNormal() const override;
 
    void SetLocalPowerProp( bool aLocal );
 
    bool GetShowPinNames() const override;
    void SetShowPinNames( bool aShow ) override;
 
    bool GetShowPinNumbers() const override;
    void SetShowPinNumbers( bool aShow ) override;
 
    double Similarity( const SCH_ITEM& aOther ) const override;

    std::unordered_set<wxString> GetComponentClassNames( const SCH_SHEET_PATH* aPath,
                                                         const wxString& aVariantName ) const;
 
    void DeleteVariant( const KIID_PATH& aPath, const wxString& aVariantName );
 
    // Remove a variant's override of one field
    void ClearVariantField( const KIID_PATH& aPath, const wxString& aVariantName,
                            const wxString& aFieldName );
 
    void RenameVariant( const KIID_PATH& aPath, const wxString& aOldName, const wxString& aNewName );
 
    void CopyVariant( const KIID_PATH& aPath, const wxString& aSourceVariant,
                      const wxString& aNewVariant );
 
    std::optional<SCH_SYMBOL_VARIANT> GetVariant( const SCH_SHEET_PATH& aInstance, const wxString& aVariantName ) const;
    void AddVariant( const SCH_SHEET_PATH& aInstance, const SCH_SYMBOL_VARIANT& aVariant );

    void SetVariantSymbolOverride( const SCH_SHEET_PATH& aPath, const wxString& aVariantName,
                                   const LIB_ID& aLibId );

    bool ClearVariantSymbolOverride( const SCH_SHEET_PATH& aPath, const wxString& aVariantName );

    std::vector<LIB_ID> GetVariantSymbolOverrides() const;

    std::unique_ptr<LIB_SYMBOL> LoadAlternateFromLibrary( const LIB_ID& aLibId ) const;

    LIB_SYMBOL* GetVariantLibSymbol( const wxString& aVariantName,
                                     const SCH_SHEET_PATH& aPath ) const;

    const LIB_SYMBOL* GetEffectiveLibSymbol( const SCH_SHEET_PATH* aPath = nullptr ) const;

    std::vector<SCH_PIN*> MapLibPins( const std::vector<SCH_PIN*>& aLibPins, bool aByNumber ) const;
 
    void DeleteVariant( const SCH_SHEET_PATH& aInstance, const wxString& aVariantName )
    {
        DeleteVariant( aInstance.Path(), aVariantName );
    }
 
    void RenameVariant( const SCH_SHEET_PATH& aInstance, const wxString& aOldName, const wxString& aNewName )
    {
        RenameVariant( aInstance.Path(), aOldName, aNewName );
    }
 
    void CopyVariant( const SCH_SHEET_PATH& aInstance, const wxString& aSourceVariant,
                      const wxString& aNewVariant )
    {
        CopyVariant( aInstance.Path(), aSourceVariant, aNewVariant );
    }
 
    bool operator==( const SCH_ITEM& aOther ) const override;
 
protected:
    void swapData( SCH_ITEM* aItem ) override;
 
    struct cmp_pins
    {
        bool operator()( const SCH_PIN* aFirst, const SCH_PIN* aSecond ) const
        {
            return *aFirst < *aSecond;
        }
    };
 
private:
    // Copy construction must relink pins without invalidating the live source screen.
    void updatePins();
 
    BOX2I doGetBoundingBox( bool aIncludePins, bool aIncludeFields ) const;
 
    bool doIsConnected( const VECTOR2I& aPosition ) const override;
 
    void Init( const VECTOR2I& pos = VECTOR2I( 0, 0 ) );
 
    void setVariantAttribute( bool aEnable, const SCH_SHEET_PATH* aInstance, const wxString& aVariantName,
                              bool SCH_SYMBOL::*aBase, bool SCH_SYMBOL_VARIANT::*aOverride );
 
    SCH_SYMBOL_INSTANCE* getInstance( const KIID_PATH& aPath );
    const SCH_SYMBOL_INSTANCE* getInstance( const KIID_PATH& aPath ) const;
 
    SCH_SYMBOL_INSTANCE* getInstance( const SCH_SHEET_PATH& aPath ) { return getInstance( aPath.Path() ); }
    const SCH_SYMBOL_INSTANCE* getInstance( const SCH_SHEET_PATH& aPath ) const { return getInstance( aPath.Path() ); }

    PIN_MAP_INSTANCE_OVERRIDE resolveDelegatedPinMapOverride( const SCH_SHEET_PATH& aSheet,
                                                              const wxString&       aVariantName ) const;
 
    void rebuildInstancePathIndex();
 
private:
    VECTOR2I              m_pos;
    LIB_ID                m_lib_id;       
    wxString              m_prefix;       

    wxString                               m_schLibSymbolName;
 
    std::vector<SCH_FIELD>                 m_fields;        

    mutable std::map<wxString, std::unique_ptr<SCH_SYMBOL_FIELD_PROPERTY>> m_fieldPropsStorageCache;

    mutable std::map<wxString, std::unique_ptr<PROPERTY_BASE>> m_pinMapPropsStorageCache;
 
    std::unique_ptr<LIB_SYMBOL>            m_part;          
    bool                                   m_doNetlist;     
 
    PASSTHROUGH_MODE                       m_passthroughMode;
 
    wxString                               m_signalName;
 
    std::vector<std::unique_ptr<SCH_PIN>>  m_pins;     
    std::unordered_map<SCH_PIN*, SCH_PIN*> m_pinMap;   

    PIN_MAP_INSTANCE_OVERRIDE              m_pinMapOverride;

    std::vector<SCH_SYMBOL_INSTANCE>       m_instances;

    std::unordered_map<KIID_PATH, size_t>  m_instancePathIndex;
 
    mutable std::map<wxString, std::unique_ptr<LIB_SYMBOL>> m_variantSymbolCache;

    static std::unordered_map<TRANSFORM, int> s_transformToOrientationCache;
};