342 lines
9.1 KiB
C++
342 lines
9.1 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2018 KiCad Developers, see CHANGELOG.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
|
|
*/
|
|
|
|
#include <unit_test_utils/unit_test_utils.h>
|
|
|
|
#include <pcbnew_utils/board_construction_utils.h>
|
|
#include <pcbnew_utils/board_file_utils.h>
|
|
|
|
#include <class_module.h>
|
|
#include <drc.h>
|
|
|
|
#include <drc/courtyard_overlap.h>
|
|
|
|
#include "../board_test_utils.h"
|
|
#include "drc_test_utils.h"
|
|
|
|
|
|
struct COURTYARD_TEST_FIXTURE
|
|
{
|
|
const KI_TEST::BOARD_DUMPER m_dumper;
|
|
};
|
|
|
|
|
|
BOOST_FIXTURE_TEST_SUITE( DrcCourtyardInvalid, COURTYARD_TEST_FIXTURE )
|
|
|
|
|
|
/*
|
|
* A simple mock module with a set of courtyard rectangles and some other
|
|
* information
|
|
*/
|
|
struct COURTYARD_INVALID_TEST_MODULE
|
|
{
|
|
/// Module Ref-Des (for identifying DRC errors)
|
|
std::string m_refdes;
|
|
/// List of segments that will be placed on the courtyard
|
|
std::vector<SEG> m_segs;
|
|
/// Module position
|
|
VECTOR2I m_pos;
|
|
};
|
|
|
|
|
|
struct COURTYARD_INVALID_INFO
|
|
{
|
|
std::string m_refdes;
|
|
|
|
int m_drc_error_code;
|
|
};
|
|
|
|
|
|
std::ostream& operator<<( std::ostream& os, const COURTYARD_INVALID_INFO& aInvalid )
|
|
{
|
|
os << "COURTYARD_INVALID_INFO[ " << aInvalid.m_refdes;
|
|
os << ", code: " << aInvalid.m_drc_error_code << "]";
|
|
return os;
|
|
}
|
|
|
|
|
|
struct COURTYARD_INVALID_CASE
|
|
{
|
|
std::string m_case_name;
|
|
|
|
std::vector<COURTYARD_INVALID_TEST_MODULE> m_mods;
|
|
|
|
std::vector<COURTYARD_INVALID_INFO> m_exp_errors;
|
|
};
|
|
|
|
// clang-format off
|
|
static const std::vector<COURTYARD_INVALID_CASE> courtyard_invalid_cases =
|
|
{
|
|
{
|
|
// Empty board has no modules to be invalid
|
|
"empty board",
|
|
{},
|
|
{},
|
|
},
|
|
{
|
|
"single mod, no courtyard",
|
|
{
|
|
{
|
|
"U1",
|
|
{}, // Empty courtyard layer
|
|
{ 0, 0 },
|
|
},
|
|
},
|
|
{ // one error: the module has no courtyard
|
|
{
|
|
"U1",
|
|
DRCE_MISSING_COURTYARD_IN_FOOTPRINT,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
"single mod, unclosed courtyard",
|
|
{
|
|
{
|
|
"U1",
|
|
{ // Unclosed polygon
|
|
{ { 0, 0 }, { 0, Millimeter2iu( 10 ) } },
|
|
{ { 0, Millimeter2iu( 10 ) }, { Millimeter2iu( 10 ), Millimeter2iu( 10 ) } },
|
|
},
|
|
{ 0, 0 },
|
|
},
|
|
},
|
|
{ // one error: the module has malformed courtyard
|
|
{
|
|
"U1",
|
|
DRCE_MALFORMED_COURTYARD_IN_FOOTPRINT,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
"single mod, disjoint courtyard",
|
|
{
|
|
{
|
|
"U1",
|
|
{ // Unclosed polygon - two disjoint segments
|
|
{ { 0, 0 }, { 0, Millimeter2iu( 10 ) } },
|
|
{ { Millimeter2iu( 10 ), 0 }, { Millimeter2iu( 10 ), Millimeter2iu( 10 ) } },
|
|
},
|
|
{ 0, 0 },
|
|
},
|
|
},
|
|
{ // one error: the module has malformed courtyard
|
|
{
|
|
"U1",
|
|
DRCE_MALFORMED_COURTYARD_IN_FOOTPRINT,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
"two mods, one OK, one malformed",
|
|
{
|
|
{
|
|
"U1",
|
|
{ // Closed polygon - triangle
|
|
{
|
|
{ 0, 0 },
|
|
{ 0, Millimeter2iu( 10 ) },
|
|
},
|
|
{
|
|
{ 0, Millimeter2iu( 10 ) },
|
|
{ Millimeter2iu( 10 ), Millimeter2iu( 10 ) }
|
|
},
|
|
{
|
|
{ Millimeter2iu( 10 ), Millimeter2iu( 10 ) },
|
|
{ 0, 0 }
|
|
},
|
|
},
|
|
{ 0, 0 },
|
|
},
|
|
{
|
|
"U2",
|
|
{ // Un-Closed polygon - one seg
|
|
{
|
|
{ 0, 0 },
|
|
{ 0, Millimeter2iu( 10 ) },
|
|
},
|
|
},
|
|
{ 0, 0 },
|
|
},
|
|
},
|
|
{ // one error: the second module has malformed courtyard
|
|
{
|
|
"U2",
|
|
DRCE_MALFORMED_COURTYARD_IN_FOOTPRINT,
|
|
},
|
|
},
|
|
},
|
|
};
|
|
// clang-format on
|
|
|
|
|
|
/**
|
|
* Construct a #MODULE to use in a courtyard test from a #COURTYARD_TEST_MODULE
|
|
* definition.
|
|
*/
|
|
std::unique_ptr<MODULE> MakeInvalidCourtyardTestModule(
|
|
BOARD& aBoard, const COURTYARD_INVALID_TEST_MODULE& aMod )
|
|
{
|
|
auto module = std::make_unique<MODULE>( &aBoard );
|
|
|
|
for( const auto& seg : aMod.m_segs )
|
|
{
|
|
const PCB_LAYER_ID layer = F_CrtYd; // aRect.m_front ? F_CrtYd : B_CrtYd;
|
|
const int width = Millimeter2iu( 0.1 );
|
|
|
|
KI_TEST::DrawSegment( *module, seg, width, layer );
|
|
}
|
|
|
|
module->SetReference( aMod.m_refdes );
|
|
|
|
// As of 2019-01-17, this has to go after adding the courtyards,
|
|
// or all the poly sets are empty when DRC'd
|
|
module->SetPosition( (wxPoint) aMod.m_pos );
|
|
|
|
return module;
|
|
}
|
|
|
|
|
|
std::unique_ptr<BOARD> MakeBoard( const std::vector<COURTYARD_INVALID_TEST_MODULE>& aMods )
|
|
{
|
|
auto board = std::make_unique<BOARD>();
|
|
|
|
for( const auto& mod : aMods )
|
|
{
|
|
auto module = MakeInvalidCourtyardTestModule( *board, mod );
|
|
|
|
board->Add( module.release() );
|
|
}
|
|
|
|
return board;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get a #BOARD_DESIGN_SETTINGS object that will cause DRC to
|
|
* check for courtyard invalidity
|
|
*/
|
|
static BOARD_DESIGN_SETTINGS GetOverlapCheckDesignSettings()
|
|
{
|
|
BOARD_DESIGN_SETTINGS des_settings;
|
|
|
|
// do the overlap tests - that's a different test, but if not set,
|
|
// the invalid courtyard checks don't run either
|
|
des_settings.m_ProhibitOverlappingCourtyards = true;
|
|
|
|
// we will also check for missing courtyards here
|
|
des_settings.m_RequireCourtyards = true;
|
|
|
|
return des_settings;
|
|
}
|
|
|
|
|
|
/**
|
|
* Check if a #MARKER_PCB is described by a particular #COURTYARD_INVALID_INFO
|
|
* object.
|
|
*/
|
|
static bool InvalidMatchesExpected(
|
|
BOARD& aBoard, const MARKER_PCB& aMarker, const COURTYARD_INVALID_INFO& aInvalid )
|
|
{
|
|
const DRC_ITEM& reporter = aMarker.GetReporter();
|
|
|
|
const MODULE* item_a = dynamic_cast<MODULE*>( reporter.GetMainItem( &aBoard ) );
|
|
|
|
// This one is more than just a mis-match!
|
|
if( reporter.HasSecondItem() )
|
|
{
|
|
BOOST_WARN_MESSAGE( false, "Expected no auxiliary item for invalid courtyard DRC." );
|
|
return false;
|
|
}
|
|
|
|
if( item_a->GetReference() != aInvalid.m_refdes )
|
|
{
|
|
return false;
|
|
}
|
|
|
|
if( reporter.GetErrorCode() != aInvalid.m_drc_error_code )
|
|
{
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
/**
|
|
* Check that the produced markers match the expected. This does NOT
|
|
* check ordering, as that is not part of the contract of the DRC function.
|
|
*
|
|
* @param aMarkers list of markers produced by the DRC
|
|
* @param aCollisions list of expected collisions
|
|
*/
|
|
static void CheckInvalidsMatchExpected( BOARD& aBoard,
|
|
const std::vector<std::unique_ptr<MARKER_PCB>>& aMarkers,
|
|
const std::vector<COURTYARD_INVALID_INFO>& aExpInvalids )
|
|
{
|
|
KI_TEST::CheckUnorderedMatches( aExpInvalids, aMarkers,
|
|
[&]( const COURTYARD_INVALID_INFO& aInvalid,
|
|
const std::unique_ptr<MARKER_PCB>& aMarker )
|
|
{
|
|
return InvalidMatchesExpected( aBoard, *aMarker, aInvalid );
|
|
} );
|
|
}
|
|
|
|
|
|
void DoCourtyardInvalidTest(
|
|
const COURTYARD_INVALID_CASE& aCase, const KI_TEST::BOARD_DUMPER& aDumper )
|
|
{
|
|
DRC_MARKER_FACTORY marker_factory;
|
|
|
|
auto board = MakeBoard( aCase.m_mods );
|
|
|
|
// Dump if env var set
|
|
aDumper.DumpBoardToFile( *board, aCase.m_case_name );
|
|
|
|
board->SetDesignSettings( GetOverlapCheckDesignSettings() );
|
|
|
|
// list of markers to collect
|
|
std::vector<std::unique_ptr<MARKER_PCB>> markers;
|
|
|
|
DRC_COURTYARD_OVERLAP drc_overlap( marker_factory, [&]( MARKER_PCB* aMarker ) {
|
|
markers.push_back( std::unique_ptr<MARKER_PCB>( aMarker ) );
|
|
} );
|
|
|
|
drc_overlap.RunDRC( *board );
|
|
|
|
CheckInvalidsMatchExpected( *board, markers, aCase.m_exp_errors );
|
|
}
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE( InvalidCases )
|
|
{
|
|
for( const auto& c : courtyard_invalid_cases )
|
|
{
|
|
BOOST_TEST_CONTEXT( c.m_case_name )
|
|
{
|
|
DoCourtyardInvalidTest( c, m_dumper );
|
|
}
|
|
}
|
|
}
|
|
|
|
BOOST_AUTO_TEST_SUITE_END() |