eda_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) 2013-2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2008-2015 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 2008 Wayne Stambaugh <[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/>.
 */
 
#ifndef EDA_ITEM_H
#define EDA_ITEM_H
 
#include <deque>
#include <map>
#include <memory>
#include <set>
 
#include <api/serializable.h>
#include <core/typeinfo.h>
#include <eda_item_flags.h>
#include <eda_search_data.h>
#include <view/view_item.h>
#include <kiid.h>
 
class SHAPE_LINE_CHAIN;
 
enum class BITMAPS : unsigned int;
 
 
enum class INSPECT_RESULT
{
    QUIT,
    CONTINUE
};
 
enum RECURSE_MODE
{
    RECURSE,
    NO_RECURSE,
};
 
#define IGNORE_PARENT_GROUP false

class UNITS_PROVIDER;
class EDA_DRAW_FRAME;
class EDA_GROUP;
class MSG_PANEL_ITEM;
class EMBEDDED_FILES;
 
namespace google::protobuf { class Any; }
 

typedef std::function< INSPECT_RESULT ( EDA_ITEM* aItem, void* aTestData ) > INSPECTOR_FUNC;

typedef const INSPECTOR_FUNC& INSPECTOR;
 

class EDA_ITEM : public KIGFX::VIEW_ITEM, public SERIALIZABLE
{
public:
    virtual ~EDA_ITEM();

    inline KICAD_T Type() const { return m_structType; }
 
    EDA_ITEM* GetParent() const { return m_parent; }
    virtual void SetParent( EDA_ITEM* aParent );
 
    virtual void SetParentGroup( EDA_GROUP* aGroup ) { m_group = aGroup; }
    virtual EDA_GROUP* GetParentGroup() const { return m_group; }
 
    KIID GetParentGroupId() const;

    bool HasSelectedAncestorGroup() const;
 
    virtual bool IsLocked() const { return false; }
    virtual void SetLocked( bool aLocked ) {}
 
    inline bool IsModified() const { return m_flags & IS_CHANGED; }
    inline bool IsNew() const { return m_flags & IS_NEW; }
    inline bool IsMoving() const { return m_flags & IS_MOVING; }
 
    inline bool IsSelected() const { return m_flags & SELECTED; }
    inline bool IsEntered() const { return m_flags & ENTERED; }
    inline bool IsBrightened() const { return ( m_flags & BRIGHTENED ) || m_netHighlighted; }

    bool IsNetHighlighted() const;
    void SetNetHighlighted( bool aHighlighted );
 
    inline bool IsRollover() const { return m_isRollover; }
    inline VECTOR2I GetRolloverPos() const { return m_rolloverPos; }
    inline void SetIsRollover( bool aIsRollover, const VECTOR2I& aMousePos )
    {
        m_isRollover = aIsRollover;
        m_rolloverPos = aMousePos;
    }
 
    inline void SetSelected() { SetFlags( SELECTED ); }
    inline void SetBrightened() { SetFlags( BRIGHTENED ); }
 
    inline void ClearSelected() { ClearFlags( SELECTED ); }
    inline void ClearBrightened() { ClearFlags( BRIGHTENED ); }
 
    void SetModified();
 
    void           SetFlags( EDA_ITEM_FLAGS aMask ) { m_flags |= aMask; }
    void           XorFlags( EDA_ITEM_FLAGS aMask ) { m_flags ^= aMask; }
    void ClearFlags( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )
    {
        m_flags &= ~aMask;
 
        if( aMask == EDA_ITEM_ALL_FLAGS )
            m_netHighlighted = false;
    }
    EDA_ITEM_FLAGS GetFlags() const { return m_flags; }
    bool           HasFlag( EDA_ITEM_FLAGS aFlag ) const { return ( m_flags & aFlag ) == aFlag; }
 
    EDA_ITEM_FLAGS GetEditFlags() const
    {
        constexpr int mask =
                ( IS_NEW | IS_PASTED | IS_MOVING | IS_BROKEN | IS_CHANGED | STRUCT_DELETED );
 
        return m_flags & mask;
    }
 
    virtual void ClearEditFlags()
    {
        ClearFlags( GetEditFlags() );
    }
 
    EDA_ITEM_FLAGS GetTempFlags() const
    {
        constexpr int mask = ( CANDIDATE | SELECTED_BY_DRAG | IS_LINKED | SKIP_STRUCT | SELECTION_CANDIDATE
                               | CONNECTIVITY_CANDIDATE );
 
        return m_flags & mask;
    }
 
    virtual void ClearTempFlags()
    {
        ClearFlags( GetTempFlags() );
    }
 
    virtual bool RenderAsBitmap( double aWorldScale ) const { return false; }
 
    void SetIsShownAsBitmap( bool aBitmap )
    {
        if( aBitmap )
            SetFlags( IS_SHOWN_AS_BITMAP );
        else
            ClearFlags( IS_SHOWN_AS_BITMAP );
    }
 
    inline bool IsShownAsBitmap() const { return m_flags & IS_SHOWN_AS_BITMAP; }

    virtual bool IsType( const std::vector<KICAD_T>& aScanTypes ) const
    {
        for( KICAD_T scanType : aScanTypes )
        {
            if( scanType == SCH_LOCATE_ANY_T || scanType == m_structType )
                return true;
        }
 
        return false;
    }

    void SetForceVisible( bool aEnable ) { m_forceVisible = aEnable; }
    bool IsForceVisible() const { return m_forceVisible; }

    const std::map<wxString, wxString>& GetCustomProperties() const
    {
        return m_customProperties;
    }
 
    void SetCustomProperties( const std::map<wxString, wxString>& aProps )
    {
        m_customProperties.clear();
 
        for( const auto& [ key, value ] : aProps )
            SetCustomProperty( key, value );
    }
 
    void SetCustomProperty( const wxString& aKey, const wxString& aValue )
    {
        for( auto& [ key, value ] : m_customProperties )
        {
            if( key.CmpNoCase( aKey ) == 0 )
            {
                value = aValue;
                return;
            }
        }
 
        m_customProperties.emplace( aKey, aValue );
    }
 
    bool HasCustomProperties() const { return !m_customProperties.empty(); }
    void ClearCustomProperties() { m_customProperties.clear(); }
 
    void RemoveCustomProperty( const wxString& aKey );

    std::vector<wxString> RemoveConflictingCustomProperties();

    bool GetCustomProperty( const wxString& aKey, wxString& aValue ) const;
 
    std::vector<PROPERTY_BASE*> GetCustomPropertiesAsInspectables() const;
 
    std::vector<PROPERTY_BASE*> GetDynamicProperties() const override;

    virtual void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
    {
    }
 
    virtual wxString GetFriendlyName() const;

    virtual bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const
    {
        return false;   // derived classes should override this function
    }

    virtual bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const
    {
        return false;   // derived classes should override this function
    }

    virtual bool HitTest( const SHAPE_LINE_CHAIN& aPoly, bool aContained ) const
    {
        return false; // derived classes should override this function
    }

    virtual const BOX2I GetBoundingBox() const;
 
    virtual VECTOR2I GetPosition() const { return VECTOR2I(); }
    virtual void     SetPosition( const VECTOR2I& aPos ){};

    virtual const VECTOR2I GetFocusPosition() const { return GetPosition(); }

    virtual VECTOR2I GetSortPosition() const { return GetPosition(); }

    virtual EDA_ITEM* Clone() const;

    virtual INSPECT_RESULT Visit( INSPECTOR inspector, void* testData,
                                  const std::vector<KICAD_T>& aScanTypes );

    template< class T >
    static INSPECT_RESULT IterateForward( std::deque<T>& aList, INSPECTOR inspector, void* testData,
                                          const std::vector<KICAD_T>& scanTypes )
    {
        for( const auto& it : aList )
        {
            EDA_ITEM* item = static_cast<EDA_ITEM*>( it );
 
            if( item && item->Visit( inspector, testData, scanTypes ) == INSPECT_RESULT::QUIT )
            {
                return INSPECT_RESULT::QUIT;
            }
        }
 
        return INSPECT_RESULT::CONTINUE;
    }

    template <class T>
    static INSPECT_RESULT IterateForward( std::vector<T>& aList, INSPECTOR inspector,
                                          void* testData, const std::vector<KICAD_T>& scanTypes )
    {
        for( const auto& it : aList )
        {
            EDA_ITEM* item = static_cast<EDA_ITEM*>( it );
 
            if( item && item->Visit( inspector, testData, scanTypes ) == INSPECT_RESULT::QUIT )
            {
                return INSPECT_RESULT::QUIT;
            }
        }
 
        return INSPECT_RESULT::CONTINUE;
    }

    wxString GetTypeDesc() const;

    virtual wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const;
 
    virtual wxString DisambiguateItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const
    {
        return GetItemDescription( aUnitsProvider, aFull );
    }

    virtual BITMAPS GetMenuImage() const;

    virtual bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const
    {
        return false;
    }

    static bool Replace( const EDA_SEARCH_DATA& aSearchData, wxString& aText );

    virtual bool Replace( const EDA_SEARCH_DATA& aSearchData, void* aAuxData = nullptr )
    {
        return false;
    }

    virtual bool IsReplaceable() const { return false; }

    bool operator<( const EDA_ITEM& aItem ) const;

    static bool Sort( const EDA_ITEM* aLeft, const EDA_ITEM* aRight ) { return *aLeft < *aRight; }

    EDA_ITEM& operator=( const EDA_ITEM& aItem );
 
    virtual const BOX2I ViewBBox() const override;
 
    virtual std::vector<int> ViewGetLayers() const override;
 
    virtual EMBEDDED_FILES* GetEmbeddedFiles() { return nullptr; }
    virtual const std::vector<wxString>* GetEmbeddedFonts() { return nullptr; }
 
#if defined(DEBUG)

    virtual void Show( int nestLevel, std::ostream& os ) const { ShowDummy( os ); };
 
    void ShowDummy( std::ostream& os ) const;  

    static std::ostream& NestedSpace( int nestLevel, std::ostream& os );
 
#endif
 
protected:
    EDA_ITEM( EDA_ITEM* parent, KICAD_T idType, bool isSCH_ITEM = false, bool isBOARD_ITEM = false );
    EDA_ITEM( KICAD_T idType, bool isSCH_ITEM = false, bool isBOARD_ITEM = false );
    EDA_ITEM( const EDA_ITEM& base );

    bool Matches( const wxString& aText, const EDA_SEARCH_DATA& aSearchData ) const;
 
    EDA_ITEM* findParent( KICAD_T aType ) const;
 
public:
    const KIID  m_Uuid;
 
private:
    KICAD_T        m_structType;
 
protected:
    EDA_ITEM_FLAGS m_flags;
    EDA_ITEM*      m_parent;        
    EDA_GROUP*     m_group;         
 
    VECTOR2I m_rolloverPos;
    bool     m_isRollover;
    bool     m_forceVisible;
    bool     m_netHighlighted = false;
 
    std::map<wxString, wxString> m_customProperties;

    mutable std::map<wxString, std::unique_ptr<PROPERTY_BASE>> m_dynamicCustomPropsCache;
};
 

inline EDA_ITEM* new_clone( const EDA_ITEM& aItem ) { return aItem.Clone(); }

struct CompareByUuid
{
    bool operator()(const EDA_ITEM* item1, const EDA_ITEM* item2) const
    {
        assert( item1 != nullptr && item2 != nullptr );
 
        if( item1->m_Uuid == item2->m_Uuid )
            return item1 < item2;
 
        return item1->m_Uuid < item2->m_Uuid;
    }
};
 

typedef std::vector< EDA_ITEM* > EDA_ITEMS;
 
typedef std::set< EDA_ITEM*, CompareByUuid > EDA_ITEM_SET;
 
#endif // EDA_ITEM_H