drc_test_provider_misc.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2004-2022 KiCad Developers.
 *
 * 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
 */

#include <board_design_settings.h>
#include <drc/drc_engine.h>
#include <drc/drc_item.h>
#include <drc/drc_rule.h>
#include <drc/drc_test_provider.h>
#include <pad.h>
#include <pcb_track.h>

#include <drawing_sheet/ds_draw_item.h>
#include <drawing_sheet/ds_proxy_view_item.h>

/*
 Miscellaneous tests:

 - DRCE_DISABLED_LAYER_ITEM, ///< item on a disabled layer
 - DRCE_INVALID_OUTLINE, ///< invalid board outline
 - DRCE_UNRESOLVED_VARIABLE,

 TODO:
 - if grows too big, split into separate providers
*/

class DRC_TEST_PROVIDER_MISC : public DRC_TEST_PROVIDER
{
public:
 DRC_TEST_PROVIDER_MISC() :
 m_board( nullptr )
 {
 m_isRuleDriven = false;
 }

 virtual ~DRC_TEST_PROVIDER_MISC()
 {
 }

 virtual bool Run() override;

 virtual const wxString GetName() const override
 {
 return wxT( "miscellaneous" );
 };

 virtual const wxString GetDescription() const override
 {
 return wxT( "Misc checks (board outline, missing textvars)" );
 }

 virtual std::set<DRC_CONSTRAINT_T> GetConstraintTypes() const override;

 int GetNumPhases() const override;

private:
 void testOutline();
 void testDisabledLayers();
 void testTextVars();

 BOARD* m_board;
};


void DRC_TEST_PROVIDER_MISC::testOutline()
{
 SHAPE_POLY_SET dummyOutline;
 bool errorHandled = false;

 OUTLINE_ERROR_HANDLER errorHandler =
 [&]( const wxString& msg, BOARD_ITEM* itemA, BOARD_ITEM* itemB, const wxPoint& pt )
 {
 std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_INVALID_OUTLINE );

 drcItem->SetErrorMessage( drcItem->GetErrorText() + wxS( " " ) + msg );
 drcItem->SetItems( itemA, itemB );

 reportViolation( drcItem, pt );
 errorHandled = true;
 };

 // Use a really tight chaining epsilon here so that we report errors that might affect
 // other tools (such as STEP export).
 constexpr int chainingEpsilon = Millimeter2iu( 0.02 ) / 100;

 if( !BuildBoardPolygonOutlines( m_board, dummyOutline, m_board->GetDesignSettings().m_MaxError,
 chainingEpsilon, &errorHandler ) )
 {
 if( errorHandled )
 {
 // if there is an invalid outline, then there must be an outline
 }
 else
 {
 std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_INVALID_OUTLINE );
 wxString msg;

 msg.Printf( _( "(no edges found on Edge.Cuts layer)" ) );

 drcItem->SetErrorMessage( drcItem->GetErrorText() + wxS( " " ) + msg );
 drcItem->SetItems( m_board );

 reportViolation( drcItem, m_board->GetBoundingBox().Centre() );
 }
 }
}


void DRC_TEST_PROVIDER_MISC::testDisabledLayers()
{
 // This is the number of tests between 2 calls to the progress bar
 const int delta = 2000;

 int ii = 0;
 int items = 0;

 auto countItems =
 [&]( BOARD_ITEM* item ) -> bool
 {
 ++items;
 return true;
 };

 LSET disabledLayers = m_board->GetEnabledLayers().flip();

 // Perform the test only for copper layers
 disabledLayers &= LSET::AllCuMask();

 auto checkDisabledLayers =
 [&]( BOARD_ITEM* item ) -> bool
 {
 if( m_drcEngine->IsErrorLimitExceeded( DRCE_DISABLED_LAYER_ITEM ) )
 return false;

 if( !reportProgress( ii++, items, delta ) )
 return false;

 PCB_LAYER_ID badLayer = UNDEFINED_LAYER;

 if( item->Type() == PCB_PAD_T )
 {
 PAD* pad = static_cast<PAD*>( item );

 if( pad->GetAttribute() == PAD_ATTRIB::SMD
 || pad->GetAttribute() == PAD_ATTRIB::CONN )
 {
 if( disabledLayers.test( item->GetLayer() ) )
 badLayer = item->GetLayer();
 }
 else
 {
 // Through hole pad is on whatever layers there are.
 }
 }
 else if( item->Type() == PCB_VIA_T )
 {
 PCB_VIA* via = static_cast<PCB_VIA*>( item );
 PCB_LAYER_ID top;
 PCB_LAYER_ID bottom;

 via->LayerPair( &top, &bottom );

 if( disabledLayers.test( top ) )
 badLayer = top;
 else if( disabledLayers.test( bottom ) )
 badLayer = bottom;
 }
 else if( item->Type() == PCB_FP_ZONE_T )
 {
 // Footprint zones just get a top/bottom/inner setting, so they're on
 // whatever inner layers there are.
 }
 else
 {
 LSET badLayers = disabledLayers & item->GetLayerSet();

 if( badLayers.any() )
 badLayer = badLayers.Seq().front();
 }

 if( badLayer != UNDEFINED_LAYER )
 {
 std::shared_ptr<DRC_ITEM>drcItem = DRC_ITEM::Create( DRCE_DISABLED_LAYER_ITEM );
 wxString msg;

 msg.Printf( _( "(layer %s)" ), LayerName( badLayer ) );

 drcItem->SetErrorMessage( drcItem->GetErrorText() + wxS( " " ) + msg );
 drcItem->SetItems( item );

 reportViolation( drcItem, item->GetPosition() );
 }

 return true;
 };

 forEachGeometryItem( s_allBasicItems, LSET::AllLayersMask(), countItems );
 forEachGeometryItem( s_allBasicItems, LSET::AllLayersMask(), checkDisabledLayers );
}


void DRC_TEST_PROVIDER_MISC::testTextVars()
{
 // This is the number of tests between 2 calls to the progress bar
 const int delta = 2000;

 int ii = 0;
 int items = 0;

 static const std::vector<KICAD_T> itemTypes = {
 PCB_TEXT_T, PCB_FP_TEXT_T,
 PCB_DIMENSION_T
 };

 forEachGeometryItem( itemTypes, LSET::AllLayersMask(),
 [&]( BOARD_ITEM* item ) -> bool
 {
 ++items;
 return true;
 } );

 forEachGeometryItem( itemTypes, LSET::AllLayersMask(),
 [&]( BOARD_ITEM* item ) -> bool
 {
 if( m_drcEngine->IsErrorLimitExceeded( DRCE_UNRESOLVED_VARIABLE ) )
 return false;

 if( !reportProgress( ii++, items, delta ) )
 return false;

 BOARD_ITEM* boardItem = dynamic_cast<BOARD_ITEM*>( item );
 EDA_TEXT* text = dynamic_cast<EDA_TEXT*>( boardItem );

 if( text && text->GetShownText().Matches( wxT( "*${*}*" ) ) )
 {
 std::shared_ptr<DRC_ITEM>drcItem = DRC_ITEM::Create( DRCE_UNRESOLVED_VARIABLE );
 drcItem->SetItems( item );

 reportViolation( drcItem, boardItem->GetPosition() );
 }
 return true;
 } );

 DS_PROXY_VIEW_ITEM* drawingSheet = m_drcEngine->GetDrawingSheet();
 DS_DRAW_ITEM_LIST drawItems;

 if( !drawingSheet || m_drcEngine->IsErrorLimitExceeded( DRCE_UNRESOLVED_VARIABLE ) )
 return;

 drawItems.SetMilsToIUfactor( IU_PER_MILS );
 drawItems.SetPageNumber( wxT( "1" ) );
 drawItems.SetSheetCount( 1 );
 drawItems.SetFileName( wxT( "dummyFilename" ) );
 drawItems.SetSheetName( wxT( "dummySheet" ) );
 drawItems.SetSheetLayer( wxT( "dummyLayer" ) );
 drawItems.SetProject( m_board->GetProject() );
 drawItems.BuildDrawItemsList( drawingSheet->GetPageInfo(), drawingSheet->GetTitleBlock() );

 for( DS_DRAW_ITEM_BASE* item = drawItems.GetFirst(); item; item = drawItems.GetNext() )
 {
 if( m_drcEngine->IsErrorLimitExceeded( DRCE_UNRESOLVED_VARIABLE ) )
 break;

 DS_DRAW_ITEM_TEXT* text = dynamic_cast<DS_DRAW_ITEM_TEXT*>( item );

 if( text && text->GetShownText().Matches( wxT( "*${*}*" ) ) )
 {
 std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_UNRESOLVED_VARIABLE );
 drcItem->SetItems( text );

 reportViolation( drcItem, text->GetPosition() );
 }
 }
}


bool DRC_TEST_PROVIDER_MISC::Run()
{
 m_board = m_drcEngine->GetBoard();

 if( !m_drcEngine->IsErrorLimitExceeded( DRCE_INVALID_OUTLINE ) )
 {
 if( !reportPhase( _( "Checking board outline..." ) ) )
 return false; // DRC cancelled

 testOutline();
 }

 if( !m_drcEngine->IsErrorLimitExceeded( DRCE_DISABLED_LAYER_ITEM ) )
 {
 if( !reportPhase( _( "Checking disabled layers..." ) ) )
 return false; // DRC cancelled

 testDisabledLayers();
 }

 if( !m_drcEngine->IsErrorLimitExceeded( DRCE_UNRESOLVED_VARIABLE ) )
 {
 if( !reportPhase( _( "Checking text variables..." ) ) )
 return false; // DRC cancelled

 testTextVars();
 }

 return true;
}


int DRC_TEST_PROVIDER_MISC::GetNumPhases() const
{
 return 3;
}


std::set<DRC_CONSTRAINT_T> DRC_TEST_PROVIDER_MISC::GetConstraintTypes() const
{
 return {};
}


namespace detail
{
static DRC_REGISTER_TEST_PROVIDER<DRC_TEST_PROVIDER_MISC> dummy;
}