sch_item.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2004 Jean-Pierre Charras, [email protected]
 * 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 <memory>
#include <optional>
#include <unordered_map>
#include <unordered_set>
#include <map>
#include <set>
 
#include <eda_item.h>
#include <properties/property.h>
#include <sch_sheet_path.h>
#include <netclass.h>
#include <stroke_params.h>
#include <layer_ids.h>
#include <sch_render_settings.h>
#include <plotters/plotter.h>
 
class CONNECTION_GRAPH;
struct CONNECTION_GRAPH_LIFETIME;
class SCH_CONNECTION;
class SCH_SHEET_PATH;
class SCHEMATIC;
class SCH_COMMIT;
class SYMBOL;
class LINE_READER;
class SCH_EDIT_FRAME;
class SCH_RULE_AREA;
struct SCH_PLOT_OPTS;
 
namespace KIFONT
{
class METRICS;
}
 
 
enum BODY_STYLE : int
{
    BASE = 1,
    DEMORGAN = 2
};
 
 
#define MINIMUM_SELECTION_DISTANCE 2 // Minimum selection distance in mils
 
 
enum AUTOPLACE_ALGO
{
    AUTOPLACE_NONE,      // No autoplacement
    AUTOPLACE_AUTO,      // A minimalist placement algorithm.
    AUTOPLACE_MANUAL     // A more involved routine that can be annoying if done from the get go.
                         //   Initiated by a hotkey or menu item.
};
 
 
enum DANGLING_END_T
{
    DANGLING_END_UNKNOWN = 0,
    WIRE_END,
    BUS_END,
    JUNCTION_END,
    PIN_END,
    LABEL_END,
    BUS_ENTRY_END,
    WIRE_ENTRY_END,
    SHEET_LABEL_END,
    NO_CONNECT_END,
};
 

class DANGLING_END_ITEM
{
public:
    DANGLING_END_ITEM( DANGLING_END_T aType, EDA_ITEM* aItem, const VECTOR2I& aPosition )
    {
        m_item = aItem;
        m_type = aType;
        m_pos = aPosition;
        m_parent = aItem;
    }
 
    DANGLING_END_ITEM( DANGLING_END_T aType, EDA_ITEM* aItem, const VECTOR2I& aPosition,
                       const EDA_ITEM* aParent )
    {
        m_item = aItem;
        m_type = aType;
        m_pos = aPosition;
        m_parent = aParent;
    }
 
    bool operator==( const DANGLING_END_ITEM& aB ) const
    {
        return GetItem() == aB.GetItem()
            && GetPosition() == aB.GetPosition()
            && GetType() == aB.GetType()
            && GetParent() == aB.GetParent();
    }
 
    bool operator<( const DANGLING_END_ITEM& rhs ) const
    {
        return( m_pos.x < rhs.m_pos.x || ( m_pos.x == rhs.m_pos.x && m_pos.y < rhs.m_pos.y )
                || ( m_pos == rhs.m_pos && m_item < rhs.m_item ) );
    }
 
    VECTOR2I GetPosition() const { return m_pos; }
    EDA_ITEM* GetItem() const { return m_item; }
    const EDA_ITEM* GetParent() const { return m_parent; }
    DANGLING_END_T GetType() const { return m_type; }
 
private:
    EDA_ITEM*       m_item;         
    VECTOR2I        m_pos;          
    DANGLING_END_T  m_type;         
    const EDA_ITEM* m_parent;       
};
 
 
class DANGLING_END_ITEM_HELPER
{
public:
    static std::vector<DANGLING_END_ITEM>::iterator
    get_lower_pos( std::vector<DANGLING_END_ITEM>& aItemListByPos, const VECTOR2I& aPos );
 
    static std::vector<DANGLING_END_ITEM>::iterator
    get_lower_type( std::vector<DANGLING_END_ITEM>& aItemListByType, const DANGLING_END_T& aType );

    static void sort_dangling_end_items( std::vector<DANGLING_END_ITEM>& aItemListByType,
                                         std::vector<DANGLING_END_ITEM>& aItemListByPos );
};
 

class SCH_ITEM : public EDA_ITEM
{
public:
    SCH_ITEM( EDA_ITEM* aParent, KICAD_T aType, int aUnit = 0, int aBodyStyle = 0 );
 
    SCH_ITEM( const SCH_ITEM& aItem );
 
    SCH_ITEM& operator=( const SCH_ITEM& aPin );
 
    virtual ~SCH_ITEM();
 
    wxString GetClass() const override
    {
        return wxT( "SCH_ITEM" );
    }
 
    bool IsType( const std::vector<KICAD_T>& aScanTypes ) const override
    {
        if( EDA_ITEM::IsType( aScanTypes ) )
            return true;
 
        for( KICAD_T scanType : aScanTypes )
        {
            if( scanType == SCH_ITEM_LOCATE_WIRE_T && m_layer == LAYER_WIRE )
                return true;
 
            if ( scanType == SCH_ITEM_LOCATE_BUS_T && m_layer == LAYER_BUS )
                return true;
 
            if ( scanType == SCH_ITEM_LOCATE_GRAPHIC_LINE_T
                    && Type() == SCH_LINE_T && m_layer == LAYER_NOTES )
            {
                return true;
            }
        }
 
        return false;
    }
 
    bool IsGroupableType() const;

    void SwapItemData( SCH_ITEM* aImage );

    void SwapFlags( SCH_ITEM* aItem );

    SCH_ITEM* Duplicate( bool addToParentGroup, SCH_COMMIT* aCommit = nullptr, bool doClone = false ) const;
 
    // Note: 0 represents "All Units", NOT the first unit
    virtual void SetUnit( int aUnit ) { m_unit = aUnit; }
    int GetUnit() const { return m_unit; }
 
    virtual void SetUnitString( const wxString& aUnit );
    virtual wxString GetUnitString() const;
 
    virtual wxString GetUnitDisplayName( int aUnit, bool aLabel ) const;
    virtual wxString GetBodyStyleDescription( int aBodyStyle, bool aLabel ) const;
 
    // Note: 0 represents "All Body Styles, NOT the first body style
    virtual void SetBodyStyle( int aBodyStyle ) { m_bodyStyle = aBodyStyle; }
    int  GetBodyStyle() const { return m_bodyStyle; }
 
    virtual void SetBodyStyleProp( const wxString& aBodyStyle );
    virtual wxString GetBodyStyleProp() const;
 
    void SetPrivate( bool aPrivate ) { m_private = aPrivate; }
    bool IsPrivate() const { return m_private; }
 
    bool IsLocked() const override;
    void SetLocked( bool aLocked ) override { m_isLocked = aLocked; }
 
    virtual void SetExcludedFromSim( bool aExclude, const SCH_SHEET_PATH* aInstance = nullptr,
                                     const wxString& aVariantName = wxEmptyString ) { }
    virtual bool GetExcludedFromSim( const SCH_SHEET_PATH* aInstance = nullptr,
                                     const wxString& aVariantName = wxEmptyString ) const { return false; }
    bool ResolveExcludedFromSim( const SCH_SHEET_PATH* aInstance = nullptr,
                                 const wxString& aVariantName = wxEmptyString ) const;
 
    virtual void SetExcludedFromBOM( bool aExcludeFromBOM, const SCH_SHEET_PATH* aInstance = nullptr,
                                     const wxString& aVariantName = wxEmptyString ) { }
    virtual bool GetExcludedFromBOM( const SCH_SHEET_PATH* aInstance = nullptr,
                                     const wxString& aVariantName = wxEmptyString ) const { return false; }
    bool ResolveExcludedFromBOM( const SCH_SHEET_PATH* aInstance = nullptr,
                                 const wxString& aVariantName = wxEmptyString ) const;
 
    virtual void SetExcludedFromBoard( bool aExclude, const SCH_SHEET_PATH* aInstance = nullptr,
                                        const wxString& aVariantName = wxEmptyString ) { }
    virtual bool GetExcludedFromBoard( const SCH_SHEET_PATH* aInstance = nullptr,
                                       const wxString& aVariantName = wxEmptyString ) const { return false; }
    bool ResolveExcludedFromBoard( const SCH_SHEET_PATH* aInstance = nullptr,
                                   const wxString& aVariantName = wxEmptyString ) const;
 
    virtual void SetExcludedFromPosFiles( bool aExclude, const SCH_SHEET_PATH* aInstance = nullptr,
                                          const wxString& aVariantName = wxEmptyString ) { }
    virtual bool GetExcludedFromPosFiles( const SCH_SHEET_PATH* aInstance = nullptr,
                                          const wxString& aVariantName = wxEmptyString ) const { return false; }
    bool ResolveExcludedFromPosFiles( const SCH_SHEET_PATH* aInstance = nullptr,
                                      const wxString& aVariantName = wxEmptyString ) const;
 
    virtual void SetDNP( bool aDNP, const SCH_SHEET_PATH* aInstance = nullptr,
                         const wxString& aVariantName = wxEmptyString ) { }
    virtual bool GetDNP( const SCH_SHEET_PATH* aInstance = nullptr,
                         const wxString& aVariantName = wxEmptyString ) const { return false; }
    bool ResolveDNP( const SCH_SHEET_PATH* aInstance = nullptr,
                     const wxString& aVariantName = wxEmptyString ) const;
 
    wxString ResolveText( const wxString& aText, const SCH_SHEET_PATH* aPath, int aDepth = 0 ) const;
    wxString ResolveText( const wxString& aText, const SCH_SHEET_PATH* aPath, int aDepth,
                          const wxString& aVariantName ) const;

    virtual bool IsMovableFromAnchorPoint() const { return true; }
 
    VECTOR2I& GetStoredPos() { return m_storedPos; }
    void      SetStoredPos( const VECTOR2I& aPos ) { m_storedPos = aPos; }

    SCHEMATIC* Schematic() const;
 
    const SYMBOL* GetParentSymbol() const;
    SYMBOL* GetParentSymbol();

    virtual bool HasHypertext() const { return false; }

    virtual bool HasHoveredHypertext() const { return HasHypertext() && IsRollover(); }
 
    virtual void DoHypertextAction( EDA_DRAW_FRAME* aFrame, const VECTOR2I& aMousePos ) const { }

    SCH_LAYER_ID GetLayer() const { return m_layer; }
    void SetLayer( SCH_LAYER_ID aLayer ) { m_layer = aLayer; }

    std::vector<int> ViewGetLayers() const override;
 
    int GetMaxError() const;

    virtual int GetPenWidth() const { return 0; }
 
    int GetEffectivePenWidth( const SCH_RENDER_SETTINGS* aSettings ) const;
 
    const wxString& GetDefaultFont( const RENDER_SETTINGS* aSettings ) const;
 
    const KIFONT::METRICS& GetFontMetrics() const;
 
    bool RenderAsBitmap( double aWorldScale ) const override;

    virtual double Similarity( const SCH_ITEM& aItem ) const
    {
        wxCHECK_MSG( false, 0.0, wxT( "Similarity not implemented in " ) + GetClass() );
    }

    double SimilarityBase( const SCH_ITEM& aItem ) const
    {
        double similarity = 1.0;
 
        if( m_unit != aItem.m_unit )
            similarity *= 0.9;
 
        if( m_bodyStyle != aItem.m_bodyStyle )
            similarity *= 0.9;
 
        if( m_private != aItem.m_private )
            similarity *= 0.9;
 
        return similarity;
    }

    virtual void Move( const VECTOR2I& aMoveVector )
    {
        wxCHECK_MSG( false, /*void*/, wxT( "Move not implemented in " ) + GetClass() );
    }

    virtual void MirrorHorizontally( int aCenter )
    {
        wxCHECK_MSG( false, /*void*/, wxT( "MirrorHorizontally not implemented in " ) + GetClass() );
    }

    virtual void MirrorVertically( int aCenter )
    {
        wxCHECK_MSG( false, /*void*/, wxT( "MirrorVertically not implemented in " ) + GetClass() );
    }

    virtual void Rotate( const VECTOR2I& aCenter, bool aRotateCCW )
    {
        wxCHECK_MSG( false, /*void*/, wxT( "Rotate not implemented in " ) + GetClass() );
    }

    virtual void BeginEdit( const VECTOR2I& aPosition ) {}

    virtual bool ContinueEdit( const VECTOR2I& aPosition ) { return false; }

    virtual void EndEdit( bool aClosed = false ) {}

    virtual void CalcEdit( const VECTOR2I& aPosition ) {}

    virtual void GetEndPoints( std::vector< DANGLING_END_ITEM >& aItemList ) {}

    virtual bool UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemListByType,
                                      std::vector<DANGLING_END_ITEM>& aItemListByPos,
                                      const SCH_SHEET_PATH*           aSheet = nullptr )
    {
        return false;
    }

    virtual bool IsEndPoint( const VECTOR2I& aPt ) const { return false; }
 
    virtual bool IsDangling() const { return false; }
 
    virtual bool CanConnect( const SCH_ITEM* aItem ) const { return m_layer == aItem->GetLayer(); }

    virtual bool IsConnectable() const { return false; }

    virtual bool IsPointClickableAnchor( const VECTOR2I& aPos ) const { return false; }

    virtual std::vector<VECTOR2I> GetConnectionPoints() const { return {}; }

    bool IsConnected( const VECTOR2I& aPoint ) const;

    SCH_CONNECTION* Connection( const SCH_SHEET_PATH* aSheet = nullptr ) const;

    std::optional<wxString> GetConnectionName( const SCH_SHEET_PATH* aSheet = nullptr,
                                              bool aLocal = false, bool aIgnoreSheet = false ) const;
 
    bool HasBusConnection( const SCH_SHEET_PATH* aSheet = nullptr ) const;

    const std::vector<SCH_ITEM*>& ConnectedItems( const SCH_SHEET_PATH& aPath ) const;

    void AddConnectionTo( const SCH_SHEET_PATH& aPath, SCH_ITEM* aItem );

    void ClearConnectedItems( const SCH_SHEET_PATH& aPath );

    SCH_CONNECTION* InitializeConnection( const SCH_SHEET_PATH& aPath, CONNECTION_GRAPH* aGraph );
 
    SCH_CONNECTION* GetOrInitConnection( const SCH_SHEET_PATH& aPath, CONNECTION_GRAPH* aGraph );

    virtual bool ConnectionPropagatesTo( const EDA_ITEM* aItem ) const { return true; }
 
    bool IsConnectivityDirty() const { return m_connectivity_dirty; }
 
    void SetConnectivityDirty( bool aDirty = true ) { m_connectivity_dirty = aDirty; }

    virtual bool HasConnectivityChanges( const SCH_ITEM* aItem,
                                         const SCH_SHEET_PATH* aInstance = nullptr ) const
    {
        return false;
    }

    void SetConnectionGraph( CONNECTION_GRAPH* aGraph );
 
    virtual bool HasCachedDriverName() const { return false; }
    virtual const wxString& GetCachedDriverName() const;
 
    virtual void SetLastResolvedState( const SCH_ITEM* aItem ) { }
 
    std::shared_ptr<NETCLASS> GetEffectiveNetClass( const SCH_SHEET_PATH* aSheet = nullptr ) const;

    AUTOPLACE_ALGO GetFieldsAutoplaced() const { return m_fieldsAutoplaced; }
    void SetFieldsAutoplaced( AUTOPLACE_ALGO aAlgo ) { m_fieldsAutoplaced = aAlgo; }
 
    virtual void AutoplaceFields( SCH_SCREEN* aScreen, AUTOPLACE_ALGO aAlgo ) { }
 
    virtual void RunOnChildren( const std::function<void( SCH_ITEM* )>& aFunction, RECURSE_MODE aMode ) { }
 
    virtual void ClearCaches();

    virtual bool HasLineStroke() const { return false; }
 
    virtual STROKE_PARAMS GetStroke() const { wxCHECK( false, STROKE_PARAMS() ); }
 
    virtual void SetStroke( const STROKE_PARAMS& aStroke ) { wxCHECK( false, /* void */ ); }
 
    void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;

    virtual void Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts,
                       int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed)
    {
        wxCHECK_MSG( false, /*void*/, wxT( "Plot not implemented in " ) + GetClass() );
    }

    void ClearRuleAreasCache() { m_rule_areas_cache.clear(); }

    void AddRuleAreaToCache( SCH_RULE_AREA* aRuleArea ) { m_rule_areas_cache.insert( aRuleArea ); }

    void RemoveRuleAreaFromCache( SCH_RULE_AREA* aRuleArea ) { m_rule_areas_cache.erase( aRuleArea ); }

    const std::unordered_set<SCH_RULE_AREA*>& GetRuleAreaCache() const
    {
        return m_rule_areas_cache;
    }
 
    const std::vector<wxString>* GetEmbeddedFonts() override;

    enum COMPARE_FLAGS : int
    {
        UNIT                   = 1 << 0,
        POSITION               = 1 << 1,
        UUID                   = 1 << 2,
        MISSING_FIELDS         = 1 << 3,
        EXTRA_FIELDS           = 1 << 4,
        FIELD_TEXT             = 1 << 5,
        FIELD_VISIBILITY       = 1 << 6,
        FIELD_SIZE_AND_STYLE   = 1 << 7,
        FIELD_POSITIONS        = 1 << 8,
        PIN_VISIBILITIES       = 1 << 9,
        PIN_ALT_DEFS           = 1 << 10,
        EXCLUDE_FROM_SIM       = 1 << 11,
        EXCLUDE_FROM_BOARD     = 1 << 12,
        DNP                    = 1 << 13,
        EXCLUDE_FROM_BOM       = 1 << 15,
        EXCLUDE_FROM_POS_FILES = 1 << 16,
        IDENTITY               = 1 << 17,
    };
 
    virtual bool operator==( const SCH_ITEM& aOther ) const;
 
    virtual bool operator<( const SCH_ITEM& aItem ) const;
 
protected:
    virtual void swapData( SCH_ITEM* aItem );
 
    SCH_RENDER_SETTINGS* getRenderSettings( PLOTTER* aPlotter ) const
    {
        return static_cast<SCH_RENDER_SETTINGS*>( aPlotter->RenderSettings() );
    }
 
    struct cmp_items
    {
        bool operator()( const SCH_ITEM* aFirst, const SCH_ITEM* aSecond ) const;
    };

    virtual int compare( const SCH_ITEM& aOther, int aCompareFlags = ~COMPARE_FLAGS::UNIT ) const;
 
private:
    friend class CONNECTION_GRAPH;

    virtual bool doIsConnected( const VECTOR2I& aPosition ) const { return false; }
 
protected:
    SCH_LAYER_ID      m_layer;
    int               m_unit;               // set to 0 if common to all units
    int               m_bodyStyle;          // set to 0 if common to all body styles
    bool              m_private;            // only shown in Symbol Editor
    AUTOPLACE_ALGO    m_fieldsAutoplaced;   // indicates status of field autoplacement
    VECTOR2I          m_storedPos;          // temp variable used in some move commands to store
                                            // an initial position of the item or mouse cursor

    std::map<SCH_SHEET_PATH, std::vector<SCH_ITEM*>, SHEET_PATH_CMP> m_connected_items;

    std::unordered_map<SCH_SHEET_PATH, SCH_CONNECTION*>              m_connection_map;
 
    bool                                                             m_connectivity_dirty;

    std::unordered_set<SCH_RULE_AREA*>                               m_rule_areas_cache;
 
    bool                                                   m_isLocked;
 
private:
    friend class LIB_SYMBOL;
    friend class CONNECTION_GRAPH;

    void registerConnectivityOwner( const std::shared_ptr<CONNECTION_GRAPH_LIFETIME>& aOwner );

    std::vector<std::weak_ptr<CONNECTION_GRAPH_LIFETIME>> m_connectivityOwners;
};
 
DECLARE_ENUM_TO_WXANY( SCH_LAYER_ID );