drc_test_provider.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2018-2024 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 DRC_TEST_PROVIDER__H
#define DRC_TEST_PROVIDER__H
 
#include <board.h>
#include <board_commit.h>
#include <pcb_marker.h>
 
#include <functional>
#include <set>
 
class DRC_ENGINE;
class DRC_TEST_PROVIDER;
class DRC_RULE;
class DRC_CONSTRAINT;
 
class DRC_TEST_PROVIDER_REGISTRY
{
public:
    DRC_TEST_PROVIDER_REGISTRY() {}
 
    ~DRC_TEST_PROVIDER_REGISTRY();
 
    static DRC_TEST_PROVIDER_REGISTRY& Instance()
    {
        static DRC_TEST_PROVIDER_REGISTRY self;
        return self;
    }
 
    void RegisterTestProvider( DRC_TEST_PROVIDER* provider ) { m_providers.push_back( provider ); }
    std::vector<DRC_TEST_PROVIDER*> GetTestProviders() const { return m_providers; }
 
private:
    std::vector<DRC_TEST_PROVIDER*> m_providers;
};
 
template<class T> class DRC_REGISTER_TEST_PROVIDER
{
public:
    DRC_REGISTER_TEST_PROVIDER()
    {
        T* provider = new T;
        DRC_TEST_PROVIDER_REGISTRY::Instance().RegisterTestProvider( provider );
    }
};
 
 
class DRC_TEST_PROVIDER : public UNITS_PROVIDER
{
public:
    DRC_TEST_PROVIDER();
    virtual ~DRC_TEST_PROVIDER() = default;
 
    static void Init();
 
    void SetDRCEngine( DRC_ENGINE *engine )
    {
        m_drcEngine = engine;
        m_stats.clear();
    }
 
    bool RunTests( EDA_UNITS aUnits )
    {
        SetUserUnits( aUnits );
        return Run();
    }
 
    virtual bool Run() = 0;
 
    virtual const wxString GetName() const;
    virtual const wxString GetDescription() const;
 
    BOARD_COMMIT* GetCommit() const { return m_commit; };
    void          SetCommit( BOARD_COMMIT* aCommit ) { m_commit = aCommit; };
 
protected:
    int forEachGeometryItem( const std::vector<KICAD_T>& aTypes, LSET aLayers,
                             const std::function<bool(BOARD_ITEM*)>& aFunc );
 
    // Do not use a wxString with a vararg list: it is a complex thing and can create issues.
    // So prefer using a wxChar* item in this case:
    void reportAux( const wxString& aMsg ) { reportAux( (const wxChar*) aMsg.wchar_str() ); }
    virtual void reportAux( const wxChar* fmt, ... );
 
    virtual void reportViolation( std::shared_ptr<DRC_ITEM>& item, const VECTOR2I& aMarkerPos,
                                  int aMarkerLayer );
    virtual bool reportProgress( size_t aCount, size_t aSize, size_t aDelta = 1 );
    virtual bool reportPhase( const wxString& aStageName );
 
    virtual void reportRuleStatistics();
    virtual void accountCheck( const DRC_RULE* ruleToTest );
    virtual void accountCheck( const DRC_CONSTRAINT& constraintToTest );
 
    bool isInvisibleText( const BOARD_ITEM* aItem ) const;
 
    wxString formatMsg( const wxString& aFormatString, const wxString& aSource, double aConstraint,
                        double aActual );
    wxString formatMsg( const wxString& aFormatString, const wxString& aSource,
                        const EDA_ANGLE& aConstraint, const EDA_ANGLE& aActual );
 
    // List of basic (ie: non-compound) geometry items
    static std::vector<KICAD_T> s_allBasicItems;
    static std::vector<KICAD_T> s_allBasicItemsButZones;
 
    EDA_UNITS   userUnits() const;
 
protected:
    DRC_ENGINE* m_drcEngine;
    std::unordered_map<const DRC_RULE*, int> m_stats;
    bool        m_isRuleDriven = true;
    std::mutex  m_statsMutex;
    BOARD_COMMIT*                            m_commit;
};
 
#endif // DRC_TEST_PROVIDER__H