drc_test_provider_silk_clearance.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 <common.h>
#include <board.h>
#include <footprint.h>
#include <pcb_shape.h>

#include <geometry/seg.h>
#include <geometry/shape_segment.h>

#include <drc/drc_engine.h>
#include <drc/drc_item.h>
#include <drc/drc_rule.h>
#include <drc/drc_test_provider_clearance_base.h>

#include <drc/drc_rtree.h>

/*
 Silk to silk clearance test. Check all silkscreen features against each other.
 Errors generated:
 - DRCE_OVERLAPPING_SILK

*/

class DRC_TEST_PROVIDER_SILK_CLEARANCE : public DRC_TEST_PROVIDER
{
public:
 DRC_TEST_PROVIDER_SILK_CLEARANCE ():
 m_board( nullptr ),
 m_largestClearance( 0 )
 {
 }

 virtual ~DRC_TEST_PROVIDER_SILK_CLEARANCE()
 {
 }

 virtual bool Run() override;

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

 virtual const wxString GetDescription() const override
 {
 return wxT( "Tests for overlapping silkscreen features." );
 }

 virtual int GetNumPhases() const override
 {
 return 1;
 }

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

private:

 BOARD* m_board;
 int m_largestClearance;
};


bool DRC_TEST_PROVIDER_SILK_CLEARANCE::Run()
{
 // This is the number of tests between 2 calls to the progress bar
 const int delta = 500;

 if( m_drcEngine->IsErrorLimitExceeded( DRCE_OVERLAPPING_SILK ) )
 {
 reportAux( wxT( "Overlapping silk violations ignored. Tests not run." ) );
 return true; // continue with other tests
 }

 m_board = m_drcEngine->GetBoard();

 DRC_CONSTRAINT worstClearanceConstraint;
 m_largestClearance = 0;

 if( m_drcEngine->QueryWorstConstraint( SILK_CLEARANCE_CONSTRAINT, worstClearanceConstraint ) )
 m_largestClearance = worstClearanceConstraint.m_Value.Min();

 reportAux( wxT( "Worst clearance : %d nm" ), m_largestClearance );

 if( !reportPhase( _( "Checking silkscreen for overlapping items..." ) ) )
 return false; // DRC cancelled

 DRC_RTREE silkTree;
 DRC_RTREE targetTree;
 int ii = 0;
 int items = 0;

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

 auto addToSilkTree =
 [&]( BOARD_ITEM* item ) -> bool
 {
 if( !reportProgress( ii++, items, delta ) )
 return false;

 for( PCB_LAYER_ID layer : { F_SilkS, B_SilkS } )
 {
 if( item->IsOnLayer( layer ) )
 silkTree.Insert( item, layer );
 }

 return true;
 };

 auto addToTargetTree =
 [&]( BOARD_ITEM* item ) -> bool
 {
 if( !reportProgress( ii++, items, delta ) )
 return false;

 for( PCB_LAYER_ID layer : item->GetLayerSet().Seq() )
 targetTree.Insert( item, layer );

 return true;
 };

 forEachGeometryItem( s_allBasicItems, LSET( 2, F_SilkS, B_SilkS ), countItems );

 forEachGeometryItem( s_allBasicItems,
 LSET::FrontMask() | LSET::BackMask() | LSET( 2, Edge_Cuts, Margin ),
 countItems );

 forEachGeometryItem( s_allBasicItems, LSET( 2, F_SilkS, B_SilkS ), addToSilkTree );

 forEachGeometryItem( s_allBasicItems,
 LSET::FrontMask() | LSET::BackMask() | LSET( 2, Edge_Cuts, Margin ),
 addToTargetTree );

 reportAux( wxT( "Testing %d silkscreen features against %d board items." ),
 silkTree.size(),
 targetTree.size() );

 const std::vector<DRC_RTREE::LAYER_PAIR> layerPairs =
 {
 DRC_RTREE::LAYER_PAIR( F_SilkS, F_SilkS ),
 DRC_RTREE::LAYER_PAIR( F_SilkS, F_Mask ),
 DRC_RTREE::LAYER_PAIR( F_SilkS, F_Adhes ),
 DRC_RTREE::LAYER_PAIR( F_SilkS, F_Paste ),
 DRC_RTREE::LAYER_PAIR( F_SilkS, F_CrtYd ),
 DRC_RTREE::LAYER_PAIR( F_SilkS, F_Fab ),
 DRC_RTREE::LAYER_PAIR( F_SilkS, F_Cu ),
 DRC_RTREE::LAYER_PAIR( F_SilkS, Edge_Cuts ),
 DRC_RTREE::LAYER_PAIR( F_SilkS, Margin ),
 DRC_RTREE::LAYER_PAIR( B_SilkS, B_SilkS ),
 DRC_RTREE::LAYER_PAIR( B_SilkS, B_Mask ),
 DRC_RTREE::LAYER_PAIR( B_SilkS, B_Adhes ),
 DRC_RTREE::LAYER_PAIR( B_SilkS, B_Paste ),
 DRC_RTREE::LAYER_PAIR( B_SilkS, B_CrtYd ),
 DRC_RTREE::LAYER_PAIR( B_SilkS, B_Fab ),
 DRC_RTREE::LAYER_PAIR( B_SilkS, B_Cu ),
 DRC_RTREE::LAYER_PAIR( B_SilkS, Edge_Cuts ),
 DRC_RTREE::LAYER_PAIR( B_SilkS, Margin )
 };

 targetTree.QueryCollidingPairs( &silkTree, layerPairs,
 [&]( const DRC_RTREE::LAYER_PAIR& aLayers, DRC_RTREE::ITEM_WITH_SHAPE* aRefItem,
 DRC_RTREE::ITEM_WITH_SHAPE* aTestItem, bool* aCollisionDetected ) -> bool
 {
 if( m_drcEngine->IsErrorLimitExceeded( DRCE_OVERLAPPING_SILK ) )
 return false;

 if( isInvisibleText( aRefItem->parent ) || isInvisibleText( aTestItem->parent ) )
 return true;

 auto constraint = m_drcEngine->EvalRules( SILK_CLEARANCE_CONSTRAINT,
 aRefItem->parent, aTestItem->parent,
 aLayers.second );

 if( constraint.IsNull() )
 return true;

 int minClearance = constraint.GetValue().Min();

 if( minClearance < 0 )
 return true;

 int actual;
 VECTOR2I pos;

 // Graphics are often compound shapes so ignore collisions between shapes in a
 // single footprint or on the board.
 PCB_SHAPE* refGraphic = dynamic_cast<PCB_SHAPE*>( aRefItem->parent );
 PCB_SHAPE* testGraphic = dynamic_cast<PCB_SHAPE*>( aTestItem->parent );

 if( refGraphic && testGraphic )
 {
 FOOTPRINT *refParentFP = dynamic_cast<FOOTPRINT*>( refGraphic->GetParent() );
 FOOTPRINT *testParentFP = dynamic_cast<FOOTPRINT*>( testGraphic->GetParent() );

 if( refParentFP == testParentFP ) // also true when both are nullptr
 return true;
 }

 if( aRefItem->shape->Collide( aTestItem->shape, minClearance, &actual, &pos ) )
 {
 std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_OVERLAPPING_SILK );

 if( minClearance > 0 )
 {
 wxString msg;

 msg.Printf( _( "(%s clearance %s; actual %s)" ),
 constraint.GetParentRule()->m_Name,
 MessageTextFromValue( userUnits(), minClearance ),
 MessageTextFromValue( userUnits(), actual ) );

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

 drcItem->SetItems( aRefItem->parent, aTestItem->parent );
 drcItem->SetViolatingRule( constraint.GetParentRule() );

 reportViolation( drcItem, (wxPoint) pos );

 *aCollisionDetected = true;
 }

 return true;
 },
 m_largestClearance,
 [&]( int aCount, int aSize ) -> bool
 {
 return reportProgress( aCount, aSize, delta );
 } );

 reportRuleStatistics();

 return true;
}


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


namespace detail
{
 static DRC_REGISTER_TEST_PROVIDER<DRC_TEST_PROVIDER_SILK_CLEARANCE> dummy;
}