rc_item.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 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 <deque>
#include <memory>
#include <vector>
#include <unordered_set>
 
#include <wx/dataview.h>
#include <units_provider.h>
#include <kiid.h>
#include <reporter.h>
 
class MARKER_BASE;
class EDA_BASE_FRAME;
class RC_ITEM;
class EDA_ITEM;
class EDA_DRAW_FRAME;
 
namespace RC_JSON
{
struct VIOLATION;
}

class RC_ITEMS_PROVIDER
{
public:
    virtual void SetSeverities( int aSeverities ) = 0;
 
    virtual int GetSeverities() const = 0;
 
    virtual int GetCount( int aSeverity = -1 ) const = 0;

    virtual std::shared_ptr<RC_ITEM> GetItem( int aIndex ) const = 0;

    virtual void DeleteItem( int aIndex, bool aDeep ) = 0;
 
    virtual ~RC_ITEMS_PROVIDER() { }
};
 

class RC_ITEM_RESOLVER
{
public:
    virtual ~RC_ITEM_RESOLVER() = default;

    EDA_ITEM* ResolveItemById( const KIID& aKiid ) const
    {
        // This is expected, e.g., when an RC item doesn't have an aux ID.
        if( aKiid == niluuid )
            return nullptr;
 
        if( m_resolutionMisses.contains( aKiid ) )
            return nullptr;
 
        EDA_ITEM* item = doResolveItemById( aKiid );
 
        if( !item )
            m_resolutionMisses.insert( aKiid );
 
        return item;
    }
 
protected:
    virtual EDA_ITEM* doResolveItemById( const KIID& aKiid ) const = 0;
 
private:
    mutable std::unordered_set<KIID> m_resolutionMisses;
};
 

class RC_ITEM
{
public:
    RC_ITEM() :
            m_errorCode( 0 ),
            m_parent( nullptr )
    {
    }
 
    RC_ITEM( const std::shared_ptr<RC_ITEM>& aItem )
    {
        m_errorCode    = aItem->m_errorCode;
        m_errorMessage = aItem->m_errorMessage;
        m_errorTitle   = aItem->m_errorTitle;
        m_settingsKey  = aItem->m_settingsKey;
        m_parent       = aItem->m_parent;
        m_ids          = aItem->m_ids;
    }
 
    virtual ~RC_ITEM() { }
 
    void SetErrorMessage( const wxString& aMessage ) { m_errorMessage = aMessage; }
 
    void SetErrorDetail( const wxString& aMsg )
    {
        SetErrorMessage( GetErrorText( true ) + wxS( " " ) + aMsg );
    }
 
    void SetItems( const std::vector<KIID>& aIds ) { m_ids = aIds; }
 
    void AddItem( EDA_ITEM* aItem );
 
    void SetItems( const EDA_ITEM* aItem, const EDA_ITEM* bItem = nullptr, const EDA_ITEM* cItem = nullptr,
                   const EDA_ITEM* dItem = nullptr );
 
    void SetItems( const KIID& aItem, const KIID& bItem = niluuid, const KIID& cItem = niluuid,
                   const KIID& dItem = niluuid )
    {
        m_ids.clear();
 
        m_ids.push_back( aItem );
        m_ids.push_back( bItem );
        m_ids.push_back( cItem );
        m_ids.push_back( dItem );
    }
 
    virtual KIID GetMainItemID() const { return m_ids.size() > 0 ? m_ids[0] : niluuid; }
    virtual KIID GetAuxItemID() const { return m_ids.size() > 1 ? m_ids[1] : niluuid; }
    virtual KIID GetAuxItem2ID() const { return m_ids.size() > 2 ? m_ids[2] : niluuid; }
    virtual KIID GetAuxItem3ID() const { return m_ids.size() > 3 ? m_ids[3] : niluuid; }
 
    std::vector<KIID> GetIDs() const { return m_ids; }
 
    void SetParent( MARKER_BASE* aMarker ) { m_parent = aMarker; }
    MARKER_BASE* GetParent() const { return m_parent; }
 

    virtual wxString ShowReport( UNITS_PROVIDER* aUnitsProvider, SEVERITY aSeverity,
                                 const RC_ITEM_RESOLVER& aResolver ) const;

    virtual void GetJsonViolation( RC_JSON::VIOLATION& aViolation, UNITS_PROVIDER* aUnitsProvider, SEVERITY aSeverity,
                                   const RC_ITEM_RESOLVER& aResolver ) const;
 
    int  GetErrorCode() const { return m_errorCode; }
    void SetErrorCode( int aCode ) { m_errorCode = aCode; }

    virtual wxString GetErrorMessage( bool aTranslate ) const;

    wxString GetErrorText( bool aTranslate ) const
    {
        if( aTranslate )
            return wxGetTranslation( m_errorTitle );
        else
            return m_errorTitle;
    }
 
    wxString GetSettingsKey() const
    {
        return m_settingsKey;
    }
 
    virtual wxString GetViolatingRuleDesc( bool aTranslate ) const
    {
        return wxEmptyString;
    }
 
protected:
    static wxString getSeverityString( SEVERITY aSeverity );

    virtual wxString getItemDescription( EDA_ITEM* aItem, int aIndex, UNITS_PROVIDER* aUnitsProvider ) const;
 
protected:
    int               m_errorCode;         
    wxString          m_errorMessage;      
    wxString          m_errorTitle;        
    wxString          m_settingsKey;       
    MARKER_BASE*      m_parent;            
 
    std::vector<KIID> m_ids;
};
 
 
class RC_TREE_NODE
{
public:
    enum NODE_TYPE
    {
        MARKER,
        MAIN_ITEM,
        AUX_ITEM,
        AUX_ITEM2,
        AUX_ITEM3,
        COMMENT
    };
 
    RC_TREE_NODE( RC_TREE_NODE* aParent, const std::shared_ptr<RC_ITEM>& aRcItem, NODE_TYPE aType ) :
            m_Type( aType ),
            m_RcItem( aRcItem ),
            m_Parent( aParent )
    {}
 
    ~RC_TREE_NODE()
    {
        for( RC_TREE_NODE* child : m_Children )
            delete child;
    }
 
    // We own at least one list of raw pointers.  Don't let the compiler fill in copy c'tors that
    // will only land us in trouble.
    RC_TREE_NODE( const RC_TREE_NODE& ) = delete;
    RC_TREE_NODE& operator=( const RC_TREE_NODE& ) = delete;
 
    struct HANDLE
    {
        RC_TREE_NODE* m_Node = nullptr;
    };
 
public:
    NODE_TYPE                  m_Type;
    std::shared_ptr<RC_ITEM>   m_RcItem;
 
    HANDLE*                    m_Handle = nullptr;
    RC_TREE_NODE*              m_Parent;
    std::vector<RC_TREE_NODE*> m_Children;
};
 
 
class RC_TREE_MODEL : public wxDataViewModel, public wxEvtHandler
{
public:
    static wxDataViewItem ToItem( RC_TREE_NODE const* aNode )
    {
        return aNode && aNode->m_Handle ? wxDataViewItem( aNode->m_Handle ) : wxDataViewItem();
    }
 
    static RC_TREE_NODE* ToNode( wxDataViewItem aItem )
    {
        auto* handle = static_cast<RC_TREE_NODE::HANDLE*>( aItem.GetID() );
        return handle ? handle->m_Node : nullptr;
    }
 
    const wxDataViewCtrl* GetView() const { return m_view; }
 
    static KIID ToUUID( wxDataViewItem aItem );
 
    RC_TREE_MODEL( EDA_DRAW_FRAME* aParentFrame, wxDataViewCtrl* aView );
 
    ~RC_TREE_MODEL();
 
    // We own at least one list of raw pointers.  Don't let the compiler fill in copy c'tors that
    // will only land us in trouble.
    RC_TREE_MODEL( const RC_TREE_MODEL& ) = delete;
    RC_TREE_MODEL& operator=( const RC_TREE_MODEL& ) = delete;
 
    void Update( std::shared_ptr<RC_ITEMS_PROVIDER> aProvider, int aSeverities );

    void EnableHyperlinks( bool aEnable );
 
    void ExpandAll();
 
    void PrevMarker();
    void NextMarker();
    void SelectMarker( const MARKER_BASE* aMarker );
    void CenterMarker( const MARKER_BASE* aMarker );
 
    bool IsContainer( wxDataViewItem const& aItem ) const override;
 
    wxDataViewItem GetParent( wxDataViewItem const& aItem ) const override;
 
    unsigned int GetChildren( wxDataViewItem const& aItem, wxDataViewItemArray&  aChildren ) const override;
 
    bool HasContainerColumns( wxDataViewItem const& aItem ) const override { return true; }
 
    bool HasValue( const wxDataViewItem& item, unsigned col ) const override
    {
        if( m_tree.empty() )
            return false;
        else
            return wxDataViewModel::HasValue( item, col );
    }

    void GetValue( wxVariant& aVariant, wxDataViewItem const& aItem, unsigned int aCol ) const override;

    bool SetValue( wxVariant const& aVariant, wxDataViewItem const& aItem, unsigned int aCol ) override
    {
        // Editing not supported
        return false;
    }

    bool GetAttr( wxDataViewItem const& aItem, unsigned int aCol, wxDataViewItemAttr& aAttr ) const override;
 
    void ValueChanged( RC_TREE_NODE* aNode );
 
    void DeleteCurrentItem( bool aDeep );

    void DeleteItems( bool aCurrentOnly, bool aIncludeExclusions, bool aDeep );
 
protected:
    RC_TREE_NODE* createNode( RC_TREE_NODE* aParent, const std::shared_ptr<RC_ITEM>& aRcItem,
                              RC_TREE_NODE::NODE_TYPE aType );
    void retireNodeTree( RC_TREE_NODE* aNode );
    void deleteNodeTree( RC_TREE_NODE* aNode );

    void clearTree();

    void rebuildTree( std::shared_ptr<RC_ITEMS_PROVIDER> aProvider, int aSeverities );
 
    void rebuildModel( std::shared_ptr<RC_ITEMS_PROVIDER> aProvider, int aSeverities );
 
    void onViewSize( wxSizeEvent& aEvent );
 
protected:
    EDA_DRAW_FRAME*                    m_editFrame;
    wxDataViewCtrl*                    m_view;
    int                                m_severities;
    bool                               m_enableHyperlinks = false;
    wxDataViewColumn*                  m_hyperlinkColumn = nullptr;
    std::shared_ptr<RC_ITEMS_PROVIDER> m_rcItemsProvider;

    std::deque<RC_TREE_NODE::HANDLE>   m_handles;
    std::vector<RC_TREE_NODE*>         m_tree;              // I own this
};