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 (C) 2020-2022 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 RC_ITEM_H
#define RC_ITEM_H
 
#include <wx/dataview.h>
#include <units_provider.h>
#include <kiid.h>
#include <reporter.h>
#include <math/vector2d.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 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
{
public:
 typedef std::vector<KIID> KIIDS;
 
 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 SetItems( const KIIDS& 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 std::map<KIID, EDA_ITEM*>& aItemMap ) const;
 
 virtual void GetJsonViolation( RC_JSON::VIOLATION& aViolation, UNITS_PROVIDER* aUnitsProvider,
 SEVERITY aSeverity, const std::map<KIID, EDA_ITEM*>& aItemMap ) const;
 
 int GetErrorCode() const { return m_errorCode; }
 void SetErrorCode( int aCode ) { m_errorCode = aCode; }
 
 virtual wxString GetErrorMessage() const;
 
 wxString GetErrorText() const
 {
 return wxGetTranslation( m_errorTitle );
 }
 
 wxString GetSettingsKey() const
 {
 return m_settingsKey;
 }
 
 virtual wxString GetViolatingRuleDesc() const
 {
 return wxEmptyString;
 }
 
protected:
 static wxString getSeverityString( SEVERITY aSeverity );
 
 int m_errorCode; 
 wxString m_errorMessage; 
 wxString m_errorTitle; 
 wxString m_settingsKey; 
 MARKER_BASE* m_parent; 
 
 KIIDS 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;
 }
 
 NODE_TYPE m_Type;
 std::shared_ptr<RC_ITEM> m_RcItem;
 
 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 wxDataViewItem( const_cast<void*>( static_cast<void const*>( aNode ) ) );
 }
 
 static RC_TREE_NODE* ToNode( wxDataViewItem aItem )
 {
 return static_cast<RC_TREE_NODE*>( aItem.GetID() );
 }
 
 static KIID ToUUID( wxDataViewItem aItem );
 
 RC_TREE_MODEL( EDA_DRAW_FRAME* aParentFrame, wxDataViewCtrl* aView );
 
 ~RC_TREE_MODEL();
 
 void Update( std::shared_ptr<RC_ITEMS_PROVIDER> aProvider, int aSeverities );
 
 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;
 
 // Simple, single-text-column model
 unsigned int GetColumnCount() const override { return 1; }
 wxString GetColumnType( unsigned int aCol ) const override { return "string"; }
 bool HasContainerColumns( wxDataViewItem const& aItem ) const override { return true; }
 
 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:
 void rebuildModel( std::shared_ptr<RC_ITEMS_PROVIDER> aProvider, int aSeverities );
 
 EDA_DRAW_FRAME* m_editFrame;
 wxDataViewCtrl* m_view;
 int m_severities;
 std::shared_ptr<RC_ITEMS_PROVIDER> m_rcItemsProvider;
 
 std::vector<RC_TREE_NODE*> m_tree; // I own this
};
 
#endif // RC_ITEM_H