erc_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/>.
 */
 
#ifndef ERC_ITEM_H
#define ERC_ITEM_H
 
#include <optional>
#include <unordered_map>
 
#include <rc_item.h>
#include <sch_sheet_path.h>
 

class ERC_TREE_MODEL : public RC_TREE_MODEL
{
public:
    ERC_TREE_MODEL( EDA_DRAW_FRAME* aParentFrame, wxDataViewCtrl* aView ) :
            RC_TREE_MODEL( aParentFrame, aView )
    {
    }
 
    ~ERC_TREE_MODEL() {}

    void GetValue( wxVariant& aVariant, wxDataViewItem const& aItem,
                   unsigned int aCol ) const override;
};
 
class ERC_ITEM : public RC_ITEM
{
public:
    static std::shared_ptr<ERC_ITEM> Create( int aErrorCode );
 
    static std::shared_ptr<ERC_ITEM> Create( const wxString& aErrorKey )
    {
        for( const std::reference_wrapper<RC_ITEM>& item : allItemTypes )
        {
            if( aErrorKey == item.get().GetSettingsKey() )
                return std::make_shared<ERC_ITEM>( static_cast<const ERC_ITEM&>( item.get() ) );
        }
 
        return nullptr;
    }
 
    static std::vector<std::reference_wrapper<RC_ITEM>> GetItemsWithSeverities()
    {
        static std::vector<std::reference_wrapper<RC_ITEM>> itemsWithSeverities;
 
        if( itemsWithSeverities.empty() )
        {
            for( std::reference_wrapper<RC_ITEM>& item : allItemTypes )
            {
                if( &item.get() == &heading_internal )
                    break;
 
                itemsWithSeverities.push_back( item );
            }
        }
 
        return itemsWithSeverities;
    }

    bool IsSheetSpecific() const { return m_sheetSpecificPath.has_value(); }

    void SetSheetSpecificPath( const SCH_SHEET_PATH& aSpecificSheet )
    {
        m_sheetSpecificPath = aSpecificSheet;
    }

    const SCH_SHEET_PATH& GetSpecificSheetPath() const
    {
        wxASSERT( m_sheetSpecificPath.has_value() );
        return m_sheetSpecificPath.value();
    }

    void SetItemsSheetPaths( const SCH_SHEET_PATH& mainItemSheet )
    {
        m_mainItemSheet = mainItemSheet;
    }

    void SetItemsSheetPaths( const SCH_SHEET_PATH& mainItemSheet, const SCH_SHEET_PATH& auxItemSheet )
    {
        m_mainItemSheet = mainItemSheet;
        m_auxItemSheet = auxItemSheet;
    }

    SCH_SHEET_PATH& GetMainItemSheetPath()
    {
        wxASSERT( MainItemHasSheetPath() );
        return m_mainItemSheet.value();
    }

    SCH_SHEET_PATH& GetAuxItemSheetPath()
    {
        wxASSERT( AuxItemHasSheetPath() );
        return m_auxItemSheet.value();
    }

    bool MainItemHasSheetPath() { return m_mainItemSheet.has_value(); }

    bool AuxItemHasSheetPath() { return m_auxItemSheet.has_value(); }
 
protected:
    wxString getItemDescription( EDA_ITEM* aItem, int aIndex, UNITS_PROVIDER* aUnitsProvider ) const override;
 
private:
    ERC_ITEM( int aErrorCode = 0, const wxString& aTitle = "", const wxString& aSettingsKey = "" )
    {
        m_errorCode   = aErrorCode;
        m_errorTitle  = aTitle;
        m_settingsKey = aSettingsKey;
    }
 
    std::optional<SCH_SHEET_PATH> m_mainItemSheet;
    std::optional<SCH_SHEET_PATH> m_auxItemSheet;

    static std::vector<std::reference_wrapper<RC_ITEM>> allItemTypes;
 
    static ERC_ITEM heading_connections;
    static ERC_ITEM heading_conflicts;
    static ERC_ITEM heading_misc;
    static ERC_ITEM heading_internal;
 
    static ERC_ITEM duplicateSheetName;
    static ERC_ITEM endpointOffGrid;
    static ERC_ITEM pinNotConnected;
    static ERC_ITEM pinNotDriven;
    static ERC_ITEM powerpinNotDriven;
    static ERC_ITEM wiredImplicitPower;
    static ERC_ITEM duplicatePinError;
    static ERC_ITEM pinTableWarning;
    static ERC_ITEM pinTableError;
    static ERC_ITEM genericWarning;
    static ERC_ITEM genericError;
    static ERC_ITEM hierLabelMismatch;
    static ERC_ITEM noConnectConnected;
    static ERC_ITEM fourWayJunction;
    static ERC_ITEM labelMultipleWires;
    static ERC_ITEM noConnectDangling;
    static ERC_ITEM labelDangling;
    static ERC_ITEM isolatedPinLabel;
    static ERC_ITEM singleGlobalLabel;
    static ERC_ITEM sameLocalGlobalLabel;
    static ERC_ITEM sameLocalGlobalPower;
    static ERC_ITEM similarLabels;
    static ERC_ITEM similarPower;
    static ERC_ITEM similarLabelAndPower;
    static ERC_ITEM differentUnitFootprint;
    static ERC_ITEM differentUnitNet;
    static ERC_ITEM busDefinitionConflict;
    static ERC_ITEM multipleNetNames;
    static ERC_ITEM netNotBusMember;
    static ERC_ITEM busToBusConflict;
    static ERC_ITEM busToNetConflict;
    static ERC_ITEM groundPinNotGround;
    static ERC_ITEM stackedPinName;
    static ERC_ITEM fieldNameWhitespace;
    static ERC_ITEM emptyLabelName;
    static ERC_ITEM emptyPowerValue;
    static ERC_ITEM pinMapBadPad;
    static ERC_ITEM pinMapUnmappedPin;
    static ERC_ITEM pinMapDuplicatePad;
    static ERC_ITEM pinMapStalePin;
    static ERC_ITEM unresolvedVariable;
    static ERC_ITEM undefinedNetclass;
    static ERC_ITEM simulationModelIssues;
    static ERC_ITEM wireDangling;
    static ERC_ITEM libSymbolIssues;
    static ERC_ITEM libSymbolMismatch;
    static ERC_ITEM footprintLinkIssues;
    static ERC_ITEM footprintFilters;
    static ERC_ITEM unannotated;
    static ERC_ITEM extraUnits;
    static ERC_ITEM missingUnits;
    static ERC_ITEM missingInputPin;
    static ERC_ITEM missingBidiPin;
    static ERC_ITEM missingPowerInputPin;
    static ERC_ITEM differentUnitValue;
    static ERC_ITEM duplicateReference;
    static ERC_ITEM busEntryNeeded;
    static ERC_ITEM unconnectedWireEndpoint;
    static ERC_ITEM variantSymbolInvalid;
    static ERC_ITEM variantSymbolIncompatible;

    std::optional<SCH_SHEET_PATH> m_sheetSpecificPath;
};
 

class SCH_RC_ITEM_RESOLVER : public RC_ITEM_RESOLVER
{
public:
    explicit SCH_RC_ITEM_RESOLVER( const SCH_SHEET_LIST& aSheetList ) :
            m_sheetList( aSheetList )
    {
    }
 
    EDA_ITEM* doResolveItemById( const KIID& aKiid ) const override;
 
private:
    const SCH_SHEET_LIST& m_sheetList;
 
    // Unlike PCBs, schematics (currently) do not have an item ID index.
    // So we cache the resolved items in a map for lookup here.
    mutable std::unordered_map<KIID, EDA_ITEM*> m_items;
    mutable bool                                m_itemsBuilt = false;
};
 
#endif      // ERC_ITEM_H