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 (C) 1992-2024 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#ifndef SCH_SYMBOL_H
#define SCH_SYMBOL_H
 
#include <eda_item.h>
#include <core/typeinfo.h>
#include <layer_ids.h>
#include <lib_id.h>
 
#include <memory>
#include <string>
#include <unordered_map>
#include <vector>
#include <wx/arrstr.h>
#include <wx/chartype.h>
#include <wx/string.h>
 
#include <schematic.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 NETLIST_OBJECT_LIST;
class SYMBOL_LIB;
class SYMBOL_LIBS;
class EE_COLLECTOR;
class SCH_SCREEN;
class SCH_COMMIT;
 
 
typedef std::vector<SCH_FIELD>    SCH_FIELDS;
 
typedef std::weak_ptr<LIB_SYMBOL> PART_REF;
 
 
extern std::string toUTFTildaText( const wxString& txt );
 
 
// @todo Move this to transform alone with all of the transform manipulation code.
enum SYMBOL_ORIENTATION_T
{
    SYM_NORMAL,                     // Normal orientation, no rotation or mirror
    SYM_ROTATE_CLOCKWISE,           // Rotate -90
    SYM_ROTATE_COUNTERCLOCKWISE,    // Rotate +90
    SYM_ORIENT_0,                   // No rotation and no mirror id SYM_NORMAL
    SYM_ORIENT_90,                  // Rotate 90, no mirror
    SYM_ORIENT_180,                 // Rotate 180, no mirror
    SYM_ORIENT_270,                 // Rotate -90, no mirror
    SYM_MIRROR_X = 0x100,           // Mirror around X axis
    SYM_MIRROR_Y = 0x200            // Mirror around Y axis
};
 
 
// Cover for SYMBOL_ORIENTATION_T for property manager (in order to expose only a subset of
// SYMBOL_ORIENTATION_T's values).
enum SYMBOL_ORIENTATION_PROP
{
    SYMBOL_ANGLE_0   = SYMBOL_ORIENTATION_T::SYM_ORIENT_0,
    SYMBOL_ANGLE_90  = SYMBOL_ORIENTATION_T::SYM_ORIENT_90,
    SYMBOL_ANGLE_180 = SYMBOL_ORIENTATION_T::SYM_ORIENT_180,
    SYMBOL_ANGLE_270 = SYMBOL_ORIENTATION_T::SYM_ORIENT_270
};
 
 
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_instanceReferences;
    }
 
    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; }
 
    void SetLibSymbol( LIB_SYMBOL* aLibSymbol );
 
    wxString GetDescription() const override;
 
    wxString GetKeyWords() const override;
 
    wxString GetDatasheet() const;
 
    void UpdatePins();
 
    bool HasUnitDisplayName( int aUnit ) const;
 
    wxString GetUnitDisplayName( int aUnit ) const;
 
    void SetBodyStyle( int aBodyStyle ) override;
 
    void SetBodyStyleUnconditional( int aBodyStyle );
 
    bool HasAlternateBodyStyle() const 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;
 
    TRANSFORM& GetTransform() { return m_transform; }
    const TRANSFORM& GetTransform() const { return m_transform; }
 
    void SetTransform( const TRANSFORM& aTransform );
 
    int GetUnitCount() const override;
 
    bool IsMulti() const override { return GetUnitCount() > 1; }
 
    void SetOrientation( int aOrientation );
 
    int GetOrientation() const;
 
    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;
 
    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 );
 
 
    const BOX2I GetBoundingBox() const override;
 
    BOX2I GetBodyBoundingBox() const;
 
    BOX2I GetBodyAndPinsBoundingBox() const;
 
 
    //-----<Fields>-----------------------------------------------------------
 
    SCH_FIELD* GetField( MANDATORY_FIELD_T aFieldType );
    const SCH_FIELD* GetField( MANDATORY_FIELD_T aFieldNdx ) const;
 
    SCH_FIELD* GetFieldById( int aFieldId );
 
    SCH_FIELD* GetFieldByName( const wxString& aFieldName );
 
    const SCH_FIELD* GetFieldByName( const wxString& aFieldName ) const;
 
    void GetFields( std::vector<SCH_FIELD*>& aVector, bool aVisibleOnly );
 
    std::vector<SCH_FIELD>& GetFields() { return m_fields; }
    const std::vector<SCH_FIELD>& GetFields() const { return m_fields; }
 
    SCH_FIELD* AddField( const SCH_FIELD& aField );
 
    void RemoveField( const wxString& aFieldName );
 
    void RemoveField( SCH_FIELD* aField ) { RemoveField( aField->GetName() ); }
 
    SCH_FIELD* FindField( const wxString& aFieldName, bool aIncludeDefaultFields = true,
                          bool aCaseInsensitive = false );
 
    const wxString GetRef( const SCH_SHEET_PATH* aSheet,
                           bool aIncludeUnit = false ) const override;
 
    const wxString GetValue( bool aResolve, const SCH_SHEET_PATH* aPath,
                             bool aAllowExtraText ) const override;
 
    void SetValueFieldText( const wxString& aValue );
 
    const wxString GetFootprintFieldText( bool aResolve, const SCH_SHEET_PATH* aPath,
                                          bool aAllowExtraText ) const;
    void SetFootprintFieldText( const wxString& aFootprint );
 
    /*
     * Field access for property manager
     */
    wxString GetRefProp() const
    {
        return GetRef( &Schematic()->CurrentSheet() );
    }
    void SetRefProp( const wxString& aRef );
    wxString GetValueProp() const
    {
        return GetValue( false, &Schematic()->CurrentSheet(), false );
    }
    void SetValueProp( const wxString& aRef )
    {
        SetValueFieldText( aRef );
    }
    int GetUnitProp() const
    {
        return GetUnitSelection( &Schematic()->CurrentSheet() );
    }
    void SetUnitProp( int aUnit )
    {
        if( aUnit < 1 )
            return;
 
        if( aUnit > GetUnitCount() )
            aUnit = GetUnitCount();
 
        SetUnitSelection( &Schematic()->CurrentSheet(), aUnit );
        SetUnit( aUnit );
    }
    int GetBodyStyleProp() const
    {
        return GetBodyStyle();
    }
    void SetBodyStyleProp( int aBodyStyle )
    {
        SetBodyStyle( aBodyStyle );
    }
 
    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 );
 
    int GetFieldCount() const { return (int)m_fields.size(); }
 
    void AutoplaceFields( SCH_SCREEN* aScreen, bool aManual ) override;
 
    void RunOnChildren( const std::function<void( SCH_ITEM* )>& aFunction ) override;
 
 
    //-----</Fields>----------------------------------------------------------
 
 
    SCH_PIN* GetPin( const wxString& number ) 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<SCH_PIN*> GetPins( const SCH_SHEET_PATH* aSheet = nullptr ) const;
 
 
    std::vector<std::unique_ptr<SCH_PIN>>& GetRawPins() { return m_pins; }
 
    void SwapData( SCH_ITEM* aItem ) override;
 
    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 );
 
    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 IsInNetlist() const;
 
    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;
 
    void Print( const SCH_RENDER_SETTINGS* aSettings, int aUnit, int aBodyStyle,
                const VECTOR2I& aOffset, bool aForceNoFill, bool aDimmed ) override;
 
    void PrintBackground( const SCH_RENDER_SETTINGS* aSettings, int aUnit, int aBodyStyle,
                          const VECTOR2I& aOffset, bool aDimmed ) 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 ) const;
 
    void PlotDNP( PLOTTER* aPlotter ) const;
 
    EDA_ITEM* Clone() const override;
 
#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 IsPower() const override;
    bool IsNormal() const override;
 
    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;
 
    bool operator==( const SCH_ITEM& aOther ) const override;
 
private:
    BOX2I doGetBoundingBox( bool aIncludePins, bool aIncludeFields ) const;
 
    bool doIsConnected( const VECTOR2I& aPosition ) const override;
 
    void Init( const VECTOR2I& pos = VECTOR2I( 0, 0 ) );
 
private:
    VECTOR2I    m_pos;
    LIB_ID      m_lib_id;       
    wxString    m_prefix;       
 
    wxString                    m_schLibSymbolName;
 
    TRANSFORM                   m_transform;     
    std::vector<SCH_FIELD>      m_fields;        
 
    std::unique_ptr<LIB_SYMBOL> m_part;          
    bool                        m_isInNetlist;   
 
    std::vector<std::unique_ptr<SCH_PIN>>  m_pins;     
    std::unordered_map<SCH_PIN*, SCH_PIN*> m_pinMap;   
 
    // Defines the hierarchical path and reference of the symbol.  This allows support for multiple
    // references to a single sub-sheet.
    std::vector<SCH_SYMBOL_INSTANCE>       m_instanceReferences;
 
    static std::unordered_map<TRANSFORM, int> s_transformToOrientationCache;
};
 
#endif /* SCH_SYMBOL_H */