kicad/pcbnew/drc/drc_test_provider.h

139 lines
4.2 KiB
C
Raw Normal View History

2020-06-13 23:28:08 +00:00
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
2024-01-04 11:49:06 +00:00
* Copyright (C) 2018-2024 KiCad Developers, see AUTHORS.txt for contributors.
2020-06-13 23:28:08 +00:00
*
* 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
2020-06-13 23:28:08 +00:00
#include <board.h>
2020-11-14 18:11:28 +00:00
#include <pcb_marker.h>
2020-06-13 23:28:08 +00:00
#include <functional>
#include <set>
class DRC_ENGINE;
class DRC_TEST_PROVIDER;
class DRC_RULE;
class DRC_CONSTRAINT;
class DRC_TEST_PROVIDER_REGISTRY
{
public:
2020-12-29 19:05:09 +00:00
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 );
}
};
2020-06-13 23:28:08 +00:00
/**
* Represent a DRC "provider" which runs some DRC functions over a #BOARD and spits out
* #DRC_ITEM and positions as needed.
2020-06-13 23:28:08 +00:00
*/
class DRC_TEST_PROVIDER : public UNITS_PROVIDER
2020-06-13 23:28:08 +00:00
{
public:
DRC_TEST_PROVIDER();
2020-12-29 19:05:09 +00:00
virtual ~DRC_TEST_PROVIDER() = default;
2020-06-13 23:28:08 +00:00
static void Init();
void SetDRCEngine( DRC_ENGINE *engine )
{
m_drcEngine = engine;
m_stats.clear();
}
bool RunTests( EDA_UNITS aUnits )
{
SetUserUnits( aUnits );
return Run();
}
2020-06-13 23:28:08 +00:00
/**
* Run this provider against the given PCB with configured options (if any).
2020-06-13 23:28:08 +00:00
*/
virtual bool Run() = 0;
virtual const wxString GetName() const;
virtual const wxString GetDescription() const;
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 );
2024-01-04 11:49:06 +00:00
virtual bool reportProgress( size_t aCount, size_t aSize, size_t aDelta = 1 );
virtual bool reportPhase( const wxString& aStageName );
2020-09-14 17:54:14 +00:00
2020-07-27 13:32:37 +00:00
virtual void reportRuleStatistics();
virtual void accountCheck( const DRC_RULE* ruleToTest );
virtual void accountCheck( const DRC_CONSTRAINT& constraintToTest );
2020-06-13 23:28:08 +00:00
bool isInvisibleText( const BOARD_ITEM* aItem ) const;
wxString formatMsg( const wxString& aFormatString, const wxString& aSource, double aConstraint,
double aActual );
// List of basic (ie: non-compound) geometry items
static std::vector<KICAD_T> s_allBasicItems;
2020-10-27 17:09:27 +00:00
static std::vector<KICAD_T> s_allBasicItemsButZones;
2020-09-11 21:50:53 +00:00
EDA_UNITS userUnits() const;
2022-03-12 13:34:25 +00:00
protected:
2020-09-11 21:50:53 +00:00
DRC_ENGINE* m_drcEngine;
std::unordered_map<const DRC_RULE*, int> m_stats;
2020-09-11 21:50:53 +00:00
bool m_isRuleDriven = true;
std::mutex m_statsMutex;
2020-06-13 23:28:08 +00:00
};
#endif // DRC_TEST_PROVIDER__H