24#include <boost/test/unit_test.hpp>
63 BOOST_REQUIRE_EQUAL( parsedRules.size(), 1 );
64 auto parsed = std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( parsedRules[0] );
69 BOOST_CHECK_CLOSE( parsed->GetMinViaDiameter(), original.
GetMinViaDiameter(), 0.0001 );
70 BOOST_CHECK_CLOSE( parsed->GetMaxViaDiameter(), original.
GetMaxViaDiameter(), 0.0001 );
72 BOOST_CHECK_CLOSE( parsed->GetMinViaHoleSize(), original.
GetMinViaHoleSize(), 0.0001 );
73 BOOST_CHECK_CLOSE( parsed->GetMaxViaHoleSize(), original.
GetMaxViaHoleSize(), 0.0001 );
92 BOOST_REQUIRE_EQUAL( parsedRules.size(), 1 );
93 auto parsed = std::dynamic_pointer_cast<DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA>( parsedRules[0] );
98 BOOST_CHECK_CLOSE( parsed->GetMinRoutingWidth(), original.
GetMinRoutingWidth(), 0.0001 );
99 BOOST_CHECK_CLOSE( parsed->GetMaxRoutingWidth(), original.
GetMaxRoutingWidth(), 0.0001 );
105 std::vector<std::shared_ptr<DRC_RE_BASE_CONSTRAINT_DATA>> rules;
107 auto rule1 = std::make_shared<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( 0, 0,
"ViaRule", 0.5, 0.8, 0.6, 0.2, 0.4, 0.3 );
108 rule1->SetConstraintCode(
"via_style" );
109 rule1->SetRuleCondition(
"A.NetClass == 'Power'" );
110 rules.push_back( rule1 );
112 auto rule2 = std::make_shared<DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA>( 0, 0,
"TrackRule", 0.2, 0.3, 0.5 );
113 rule2->SetConstraintCode(
"track_width" );
114 rule2->SetRuleCondition(
"A.NetClass == 'Signal'" );
115 rules.push_back( rule2 );
117 wxString filename =
"test_rules.dru";
123 wxFFile file( filename );
126 file.ReadAll( &content );
129 BOOST_CHECK( content.Contains(
"(version 1)" ) );
130 BOOST_CHECK( content.Contains(
"(rule ViaRule" ) );
131 BOOST_CHECK( content.Contains(
"(constraint via_diameter" ) );
132 BOOST_CHECK( content.Contains(
"(constraint hole_size" ) );
133 BOOST_CHECK( content.Contains(
"(rule TrackRule" ) );
134 BOOST_CHECK( content.Contains(
"(constraint track_width" ) );
137 wxRemoveFile( filename );
143 std::vector<RULE_TREE_NODE> ruleTreeNodeDatas;
151 auto data = std::make_shared<DRC_RE_BASE_CONSTRAINT_DATA>( 1, 0,
"TestRule" );
152 data->SetConstraintCode(
"clearance" );
155 ruleTreeNodeDatas.push_back( node );
158 std::vector<std::shared_ptr<DRC_RE_BASE_CONSTRAINT_DATA>> rules;
162 if( n.m_nodeType !=
RULE )
165 auto d = std::dynamic_pointer_cast<DRC_RE_BASE_CONSTRAINT_DATA>( n.m_nodeData );
168 rules.push_back( d );
176 auto rule = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>( 0, 0, 0.2,
"ClearanceRule" );
177 rule->SetConstraintCode(
"clearance" );
183 wxString ruleText = rule->GenerateRule( ctx );
185 BOOST_CHECK( ruleText.Contains(
"(constraint clearance (min 0.2mm))" ) );
188 auto rule2 = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>( 0, 0, 10,
"ViaCountRule" );
189 rule2->SetConstraintCode(
"via_count" );
190 ctx.
ruleName = rule2->GetRuleName();
193 ruleText = rule2->GenerateRule( ctx );
194 BOOST_CHECK( ruleText.Contains(
"(constraint via_count (max 10))" ) );
197 auto rule3 = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>( 0, 0, 45,
"AngleRule" );
198 rule3->SetConstraintCode(
"track_angle" );
199 ctx.
ruleName = rule3->GetRuleName();
202 ruleText = rule3->GenerateRule( ctx );
203 BOOST_CHECK( ruleText.Contains(
"(constraint track_angle (min 45deg))" ) );
208 auto rule = std::make_shared<DRC_RE_BOOL_INPUT_CONSTRAINT_DATA>( 0, 0,
true,
"DisallowTestRule" );
209 rule->SetConstraintCode(
"disallow" );
215 wxString ruleText = rule->GenerateRule( ctx );
217 BOOST_CHECK( ruleText.Contains(
"(constraint disallow)" ) );
220 auto rule2 = std::make_shared<DRC_RE_BOOL_INPUT_CONSTRAINT_DATA>( 0, 0,
false,
"NoDisallowTestRule" );
221 rule2->SetConstraintCode(
"disallow" );
222 ctx.
ruleName = rule2->GetRuleName();
225 ruleText = rule2->GenerateRule( ctx );
226 BOOST_CHECK( ruleText.IsEmpty() );
233 "(rule \"Clearance Rule\"\n"
234 "\t(constraint clearance (min 0.2mm))\n"
235 "\t(condition \"A.NetClass == 'Power'\"))\n"
236 "(rule \"Via Style Rule\"\n"
237 "\t(constraint via_diameter (min 0.5mm))\n"
238 "\t(constraint hole_size (min 0.3mm))\n"
239 "\t(condition \"A.NetClass == 'Power'\"))\n";
243 BOOST_REQUIRE_EQUAL( parsedRules.size(), 2 );
246 auto clearanceRule = parsedRules[0];
251 auto numericData = std::dynamic_pointer_cast<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>( clearanceRule );
253 BOOST_CHECK_CLOSE( numericData->GetNumericInputValue(), 0.2, 0.0001 );
256 auto viaStyleRule = parsedRules[1];
260 auto viaData = std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( viaStyleRule );
262 BOOST_CHECK_CLOSE( viaData->GetMinViaDiameter(), 0.5, 0.0001 );
263 BOOST_CHECK_CLOSE( viaData->GetMinViaHoleSize(), 0.3, 0.0001 );
269 bool parserCalled =
false;
271 [&](
const std::shared_ptr<DRC_RULE>& aRule ) -> std::shared_ptr<DRC_RE_BASE_CONSTRAINT_DATA>
276 auto data = std::make_shared<DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA>( 0, 0, aRule->m_Name );
277 data->SetConstraintCode(
"custom_clearance" );
283 wxString ruleText =
"(version 1) (rule \"Test Rule\" (constraint clearance (min 1.0mm)) (condition \"A.Type == 'Pad'\"))";
286 BOOST_CHECK( parserCalled );
287 BOOST_REQUIRE_EQUAL( parsedRules.size(), 1 );
297 BOOST_CHECK(
result.isValid );
298 BOOST_CHECK(
result.errors.empty() );
308 BOOST_CHECK( !
result.isValid );
309 BOOST_CHECK( !
result.errors.empty() );
312 bool foundMinMaxError =
false;
313 for(
const auto& error :
result.errors )
315 if( error.find(
"Minimum Via Diameter cannot be greater than Maximum Via Diameter" ) != std::string::npos )
316 foundMinMaxError =
true;
318 BOOST_CHECK( foundMinMaxError );
328 BOOST_CHECK( !
result.isValid );
329 BOOST_CHECK( !
result.errors.empty() );
332 bool foundNegativeError =
false;
333 for(
const auto& error :
result.errors )
335 if( error.find(
"must be greater than 0" ) != std::string::npos )
336 foundNegativeError =
true;
338 BOOST_CHECK( foundNegativeError );
345 [](
const std::shared_ptr<DRC_RULE>& aRule ) -> std::shared_ptr<DRC_RE_BASE_CONSTRAINT_DATA> {
346 if( aRule->m_Name ==
"Test" )
347 return std::make_shared<DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA>( 0, 0, aRule->m_Name +
"_1" );
353 [](
const std::shared_ptr<DRC_RULE>& aRule ) -> std::shared_ptr<DRC_RE_BASE_CONSTRAINT_DATA> {
354 if( aRule->m_Name ==
"Test" )
355 return std::make_shared<DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA>( 0, 0, aRule->m_Name +
"_2" );
359 wxString ruleText =
"(version 1) (rule \"Test\" (constraint clearance (min 1.0mm)))";
362 BOOST_REQUIRE_EQUAL( parsedRules.size(), 1 );
373 BOOST_CHECK(
result.isValid );
374 BOOST_CHECK(
result.errors.empty() );
384 BOOST_CHECK( !result1.
isValid );
385 BOOST_CHECK( !result1.
errors.empty() );
387 bool foundMinMaxError =
false;
389 for(
const auto& error : result1.
errors )
391 if( error.find(
"Minimum Length cannot be greater than Maximum Length" ) != std::string::npos )
392 foundMinMaxError =
true;
395 BOOST_CHECK( foundMinMaxError );
402 BOOST_CHECK( !result2.
isValid );
404 bool foundNegativeError =
false;
406 for(
const auto& error : result2.
errors )
408 if( error.find(
"must be greater than 0" ) != std::string::npos )
409 foundNegativeError =
true;
412 BOOST_CHECK( foundNegativeError );
423 BOOST_CHECK(
result.isValid );
424 BOOST_CHECK(
result.errors.empty() );
434 BOOST_CHECK( !result1.
isValid );
435 BOOST_CHECK( !result1.
errors.empty() );
437 bool foundWidthError =
false;
438 for(
const auto& error : result1.
errors )
440 if( error.find(
"Minimum Width cannot be greater than Maximum Width" ) != std::string::npos )
441 foundWidthError =
true;
443 BOOST_CHECK( foundWidthError );
450 BOOST_CHECK( !result2.
isValid );
452 bool foundNegativeError =
false;
453 for(
const auto& error : result2.
errors )
455 if( error.find(
"must be greater than 0" ) != std::string::npos )
456 foundNegativeError =
true;
458 BOOST_CHECK( foundNegativeError );
468 BOOST_CHECK( result1.
isValid );
469 BOOST_CHECK( result1.
errors.empty() );
476 BOOST_CHECK( result2.
isValid );
477 BOOST_CHECK( result2.
errors.empty() );
484 BOOST_CHECK( result3.
isValid );
485 BOOST_CHECK( result3.
errors.empty() );
495 BOOST_CHECK( !
result.isValid );
496 BOOST_CHECK( !
result.errors.empty() );
498 bool foundLayerError =
false;
499 for(
const auto& error :
result.errors )
501 if( error.find(
"At least one layer must be selected" ) != std::string::npos )
502 foundLayerError =
true;
504 BOOST_CHECK( foundLayerError );
513 BOOST_CHECK(
result.isValid );
514 BOOST_CHECK(
result.errors.empty() );
523 BOOST_CHECK( !
result.isValid );
524 BOOST_CHECK( !
result.errors.empty() );
527 bool foundError =
false;
528 for(
const auto& error :
result.errors )
530 if( error.find(
"must be greater than 0" ) != std::string::npos )
533 BOOST_CHECK( foundError );
542 BOOST_CHECK(
result.isValid );
543 BOOST_CHECK(
result.errors.empty() );
553 BOOST_CHECK( !
result.isValid );
554 BOOST_CHECK( !
result.errors.empty() );
557 bool foundMinMaxError =
false;
558 for(
const auto& error :
result.errors )
560 if( error.find(
"Minimum Routing Width cannot be greater than Maximum Routing Width" ) != std::string::npos )
561 foundMinMaxError =
true;
563 BOOST_CHECK( foundMinMaxError );
573 BOOST_CHECK( result1.
isValid );
574 BOOST_CHECK( result1.
errors.empty() );
581 BOOST_CHECK( result2.
isValid );
582 BOOST_CHECK( result2.
errors.empty() );
589 BOOST_CHECK( result3.
isValid );
590 BOOST_CHECK( result3.
errors.empty() );
597 BOOST_CHECK( result4.
isValid );
598 BOOST_CHECK( result4.
errors.empty() );
608 BOOST_CHECK( !
result.isValid );
609 BOOST_CHECK( !
result.errors.empty() );
611 bool foundOrientationError =
false;
612 for(
const auto& error :
result.errors )
614 if( error.find(
"At least one orientation must be selected" ) != std::string::npos )
615 foundOrientationError =
true;
617 BOOST_CHECK( foundOrientationError );
627 BOOST_CHECK( resultTrue.
isValid );
628 BOOST_CHECK( resultTrue.
errors.empty() );
635 BOOST_CHECK( resultFalse.
isValid );
636 BOOST_CHECK( resultFalse.
errors.empty() );
646 BOOST_CHECK(
result.isValid );
647 BOOST_CHECK(
result.errors.empty() );
657 BOOST_CHECK( !result1.
isValid );
658 BOOST_CHECK( !result1.
errors.empty() );
660 bool foundHeightError =
false;
661 for(
const auto& error : result1.
errors )
663 if( error.find(
"Minimum Text Height must be greater than 0" ) != std::string::npos )
664 foundHeightError =
true;
666 BOOST_CHECK( foundHeightError );
673 BOOST_CHECK( !result2.
isValid );
675 bool foundThicknessError =
false;
676 for(
const auto& error : result2.
errors )
678 if( error.find(
"Minimum Text Thickness must be greater than 0" ) != std::string::npos )
679 foundThicknessError =
true;
681 BOOST_CHECK( foundThicknessError );
688 BOOST_CHECK( !result3.
isValid );
695 data.
SetRuleText(
"(constraint clearance (min 0.2mm))" );
699 BOOST_CHECK(
result.isValid );
700 BOOST_CHECK(
result.errors.empty() );
710 BOOST_CHECK( !
result.isValid );
711 BOOST_CHECK( !
result.errors.empty() );
714 bool foundEmptyError =
false;
715 for(
const auto& error :
result.errors )
717 if( error.find(
"Rule text cannot be empty" ) != std::string::npos )
718 foundEmptyError =
true;
720 BOOST_CHECK( foundEmptyError );
746 std::vector<DRC_PANEL_MATCH> matches = matcher.
MatchRule( rule );
748 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
758 DRC_RULE rule(
"ViaDiameterOnlyRule" );
765 std::vector<DRC_PANEL_MATCH> matches = matcher.
MatchRule( rule );
767 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
791 std::vector<DRC_PANEL_MATCH> matches = matcher.
MatchRule( rule );
793 BOOST_REQUIRE_EQUAL( matches.size(), 2 );
823 std::vector<DRC_PANEL_MATCH> matches = matcher.
MatchRule( rule );
825 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
834 DRC_RULE rule(
"DiffPairWithUncoupledRule" );
849 std::vector<DRC_PANEL_MATCH> matches = matcher.
MatchRule( rule );
851 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
862 DRC_RULE rule(
"TrackWidthOnlyRule" );
871 std::vector<DRC_PANEL_MATCH> matches = matcher.
MatchRule( rule );
873 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
892 std::vector<DRC_PANEL_MATCH> matches = matcher.
MatchRule( rule );
894 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
911 std::vector<DRC_PANEL_MATCH> matches = matcher.
MatchRule( rule );
913 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
924 std::vector<DRC_PANEL_MATCH> matches = matcher.
MatchRule( rule );
969 "(rule \"Via Test\"\n"
970 " (constraint via_diameter (min 0.5mm) (opt 0.6mm) (max 0.8mm))\n"
971 " (constraint hole_size (min 0.2mm) (opt 0.3mm) (max 0.4mm)))";
974 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( ruleText );
976 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
980 auto viaData = std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( entries[0].constraintData );
983 BOOST_CHECK_CLOSE( viaData->GetMinViaDiameter(), 0.5, 0.0001 );
984 BOOST_CHECK_CLOSE( viaData->GetPreferredViaDiameter(), 0.6, 0.0001 );
985 BOOST_CHECK_CLOSE( viaData->GetMaxViaDiameter(), 0.8, 0.0001 );
986 BOOST_CHECK_CLOSE( viaData->GetMinViaHoleSize(), 0.2, 0.0001 );
987 BOOST_CHECK_CLOSE( viaData->GetPreferredViaHoleSize(), 0.3, 0.0001 );
988 BOOST_CHECK_CLOSE( viaData->GetMaxViaHoleSize(), 0.4, 0.0001 );
996 "(rule \"Track Test\"\n"
997 " (constraint track_width (min 0.2mm) (opt 0.25mm) (max 0.3mm)))";
1000 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( ruleText );
1002 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1006 auto trackData = std::dynamic_pointer_cast<DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA>( entries[0].constraintData );
1009 BOOST_CHECK_CLOSE( trackData->GetMinRoutingWidth(), 0.2, 0.0001 );
1010 BOOST_CHECK_CLOSE( trackData->GetPreferredRoutingWidth(), 0.25, 0.0001 );
1011 BOOST_CHECK_CLOSE( trackData->GetMaxRoutingWidth(), 0.3, 0.0001 );
1019 "(rule \"Diff Pair Test\"\n"
1020 " (constraint track_width (min 0.2mm) (opt 0.25mm) (max 0.3mm))\n"
1021 " (constraint diff_pair_gap (min 0.1mm) (opt 0.15mm) (max 0.2mm))\n"
1022 " (constraint diff_pair_uncoupled (max 5mm)))";
1025 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( ruleText );
1027 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1030 auto dpData = std::dynamic_pointer_cast<DRC_RE_ROUTING_DIFF_PAIR_CONSTRAINT_DATA>( entries[0].constraintData );
1033 BOOST_CHECK_CLOSE( dpData->GetMinWidth(), 0.2, 0.0001 );
1034 BOOST_CHECK_CLOSE( dpData->GetPreferredWidth(), 0.25, 0.0001 );
1035 BOOST_CHECK_CLOSE( dpData->GetMaxWidth(), 0.3, 0.0001 );
1036 BOOST_CHECK_CLOSE( dpData->GetMinGap(), 0.1, 0.0001 );
1037 BOOST_CHECK_CLOSE( dpData->GetPreferredGap(), 0.15, 0.0001 );
1038 BOOST_CHECK_CLOSE( dpData->GetMaxGap(), 0.2, 0.0001 );
1039 BOOST_CHECK_CLOSE( dpData->GetMaxUncoupledLength(), 5.0, 0.0001 );
1047 "(rule \"Split Test\"\n"
1048 " (constraint via_diameter (min 0.5mm))\n"
1049 " (constraint hole_size (min 0.2mm))\n"
1050 " (constraint clearance (min 0.15mm)))";
1053 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( ruleText );
1055 BOOST_REQUIRE_EQUAL( entries.size(), 2 );
1065 auto numericData = std::dynamic_pointer_cast<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>( entries[1].constraintData );
1067 BOOST_CHECK_CLOSE( numericData->GetNumericInputValue(), 0.15, 0.0001 );
1077 "(rule \"clearance_under_fpga\"\n"
1078 " (constraint clearance (min 0.1mm))\n"
1079 " (constraint hole_size (min 0.2mm))\n"
1080 " (constraint via_diameter (min 0.4mm))\n"
1081 " (condition \"A.intersectsArea('underFPGA') || A.intersectsArea('underDDR')\"))";
1084 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( ruleText );
1087 BOOST_REQUIRE_EQUAL( entries.size(), 2 );
1092 BOOST_CHECK_EQUAL( entries[0].condition,
"A.intersectsArea('underFPGA') || A.intersectsArea('underDDR')" );
1097 BOOST_CHECK_EQUAL( entries[1].condition,
"A.intersectsArea('underFPGA') || A.intersectsArea('underDDR')" );
1100 auto viaData = std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( entries[0].constraintData );
1102 BOOST_CHECK_CLOSE( viaData->GetMinViaDiameter(), 0.4, 0.0001 );
1103 BOOST_CHECK_CLOSE( viaData->GetMinViaHoleSize(), 0.2, 0.0001 );
1106 auto clearanceData = std::dynamic_pointer_cast<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>( entries[1].constraintData );
1108 BOOST_CHECK_CLOSE( clearanceData->GetNumericInputValue(), 0.1, 0.0001 );
1116 "(rule \"Text Test\"\n"
1117 " (constraint text_height (min 1mm))\n"
1118 " (constraint text_thickness (min 0.15mm)))";
1121 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( ruleText );
1123 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1126 auto textData = std::dynamic_pointer_cast<DRC_RE_MINIMUM_TEXT_HEIGHT_THICKNESS_CONSTRAINT_DATA>( entries[0].constraintData );
1129 BOOST_CHECK_CLOSE( textData->GetMinTextHeight(), 1.0, 0.0001 );
1130 BOOST_CHECK_CLOSE( textData->GetMinTextThickness(), 0.15, 0.0001 );
1138 "(rule \"Length Test\"\n"
1139 " (constraint length (min 10mm) (opt 30mm) (max 50mm)))";
1142 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( ruleText );
1144 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1148 auto lengthData = dynamic_pointer_cast<DRC_RE_ABSOLUTE_LENGTH_TWO_CONSTRAINT_DATA>( entries[0].constraintData );
1150 BOOST_CHECK_CLOSE( lengthData->GetMinimumLength(), 10.0, 0.0001 );
1151 BOOST_CHECK_CLOSE( lengthData->GetOptimumLength(), 30.0, 0.0001 );
1152 BOOST_CHECK_CLOSE( lengthData->GetMaximumLength(), 50.0, 0.0001 );
1160 "(rule \"Conditional Test\"\n"
1161 " (condition \"A.NetClass == 'Power'\")\n"
1162 " (constraint clearance (min 0.3mm)))";
1165 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( ruleText );
1167 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1170 BOOST_CHECK_EQUAL( entries[0].constraintData->GetRuleCondition(),
"A.NetClass == 'Power'" );
1178 "(rule \"Rule A\"\n"
1179 " (constraint clearance (min 0.2mm)))\n"
1180 "(rule \"Rule B\"\n"
1181 " (constraint track_width (min 0.15mm)))\n"
1182 "(rule \"Rule C\"\n"
1183 " (constraint via_diameter (min 0.5mm))\n"
1184 " (constraint hole_size (min 0.3mm)))";
1187 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( ruleText );
1189 BOOST_REQUIRE_EQUAL( entries.size(), 3 );
1206 "(rule \"Empty Rule\")";
1209 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( ruleText );
1211 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1219 wxString ruleText =
"not valid rule text at all";
1222 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( ruleText );
1232 "(rule \"Edge Clearance\"\n"
1233 " (constraint edge_clearance (min 0.5mm)))\n"
1234 "(rule \"Hole Clearance\"\n"
1235 " (constraint hole_clearance (min 0.3mm)))\n"
1236 "(rule \"Courtyard\"\n"
1237 " (constraint courtyard_clearance (min 0.25mm)))";
1240 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( ruleText );
1242 BOOST_REQUIRE_EQUAL( entries.size(), 3 );
1262 auto numericData = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>();
1263 numericData->SetRuleName(
"TestClearance" );
1264 numericData->SetConstraintCode(
"clearance" );
1265 numericData->SetNumericInputValue( 0.2 );
1269 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1272 BOOST_CHECK(
result.Contains(
"(version 1)" ) );
1273 BOOST_CHECK(
result.Contains(
"TestClearance" ) );
1274 BOOST_CHECK(
result.Contains(
"clearance" ) );
1283 entry.
originalRuleText =
"(rule \"Preserved Rule\"\n\t(constraint clearance (min 0.5mm)))";
1286 auto numericData = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>();
1287 numericData->SetRuleName(
"Preserved Rule" );
1288 numericData->SetConstraintCode(
"clearance" );
1289 numericData->SetNumericInputValue( 0.5 );
1293 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1305 entry.
originalRuleText =
"(rule \"EditedRule\"\n\t(constraint clearance (min 0.5mm)))";
1308 auto numericData = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>();
1309 numericData->SetRuleName(
"EditedRule" );
1310 numericData->SetConstraintCode(
"clearance" );
1311 numericData->SetNumericInputValue( 0.3 );
1315 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1319 BOOST_CHECK( !
result.Contains(
"0.5mm" ) );
1320 BOOST_CHECK(
result.Contains(
"EditedRule" ) );
1330 auto viaData = std::make_shared<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>();
1331 viaData->SetRuleName(
"ViaTest" );
1332 viaData->SetMinViaDiameter( 0.5 );
1333 viaData->SetPreferredViaDiameter( 0.6 );
1334 viaData->SetMaxViaDiameter( 0.8 );
1335 viaData->SetMinViaHoleSize( 0.2 );
1336 viaData->SetPreferredViaHoleSize( 0.3 );
1337 viaData->SetMaxViaHoleSize( 0.4 );
1342 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1345 BOOST_CHECK(
result.Contains(
"ViaTest" ) );
1346 BOOST_CHECK(
result.Contains(
"via_diameter" ) );
1347 BOOST_CHECK(
result.Contains(
"hole_size" ) );
1353 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries;
1358 auto data1 = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>();
1359 data1->SetRuleName(
"RuleA" );
1360 data1->SetConstraintCode(
"clearance" );
1361 data1->SetNumericInputValue( 0.2 );
1364 entries.push_back( entry1 );
1369 auto data2 = std::make_shared<DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA>();
1370 data2->SetRuleName(
"RuleB" );
1371 data2->SetMinRoutingWidth( 0.15 );
1372 data2->SetPreferredRoutingWidth( 0.2 );
1373 data2->SetMaxRoutingWidth( 0.3 );
1376 entries.push_back( entry2 );
1382 BOOST_CHECK(
result.Contains(
"RuleA" ) );
1383 BOOST_CHECK(
result.Contains(
"RuleB" ) );
1386 size_t posA =
result.Find(
"RuleA" );
1387 size_t posB =
result.Find(
"RuleB" );
1388 BOOST_CHECK( posA < posB );
1396 entry.
ruleName =
"ConditionalRule";
1397 entry.
condition =
"A.NetClass == 'Power'";
1399 auto numericData = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>();
1400 numericData->SetRuleName(
"ConditionalRule" );
1401 numericData->SetConstraintCode(
"clearance" );
1402 numericData->SetRuleCondition(
"A.NetClass == 'Power'" );
1403 numericData->SetNumericInputValue( 0.3 );
1408 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1411 BOOST_CHECK(
result.Contains(
"ConditionalRule" ) );
1412 BOOST_CHECK(
result.Contains(
"condition" ) );
1413 BOOST_CHECK(
result.Contains(
"Power" ) );
1420 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries;
1423 BOOST_CHECK(
result.Contains(
"(version 1)" ) );
1438 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1442 BOOST_CHECK(
result.Contains(
"(version 1)" ) );
1443 BOOST_CHECK( !
result.Contains(
"Null Data Rule" ) );
1449 wxString originalText =
1451 "(rule \"RoundTripTest\"\n"
1452 " (constraint clearance (min 0.25mm)))";
1455 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( originalText );
1457 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1461 entries[0].wasEdited =
true;
1468 std::vector<DRC_RE_LOADED_PANEL_ENTRY> reloadedEntries = loader.
LoadFromString( savedText );
1470 BOOST_REQUIRE_EQUAL( reloadedEntries.size(), 1 );
1482 auto dpData = std::make_shared<DRC_RE_ROUTING_DIFF_PAIR_CONSTRAINT_DATA>();
1483 dpData->SetRuleName(
"DiffPairTest" );
1484 dpData->SetMinWidth( 0.2 );
1485 dpData->SetPreferredWidth( 0.25 );
1486 dpData->SetMaxWidth( 0.3 );
1487 dpData->SetMinGap( 0.1 );
1488 dpData->SetPreferredGap( 0.15 );
1489 dpData->SetMaxGap( 0.2 );
1490 dpData->SetMaxUncoupledLength( 5.0 );
1495 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1498 BOOST_CHECK(
result.Contains(
"DiffPairTest" ) );
1499 BOOST_CHECK(
result.Contains(
"track_width" ) );
1500 BOOST_CHECK(
result.Contains(
"diff_pair_gap" ) );
1513 "(rule \"PTH to Track Clearance\"\n"
1514 " (constraint hole_clearance (min 1.0mm))\n"
1515 " (condition \"A.Type == 'Pad' && A.Pad_Type == 'Through-hole' && B.Type =='Track'\"))\n"
1516 "(rule \"Max Drill Hole Size Mechanical\"\n"
1517 " (constraint hole (max 2.0mm))\n"
1518 " (condition \"A.Type == 'Pad'\"))";
1521 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( ruleText );
1523 BOOST_REQUIRE_GE( entries.size(), 2 );
1528 BOOST_CHECK( !entries[0].condition.IsEmpty() );
1540 "(rule board_edge\n"
1541 " (constraint edge_clearance (min 1mm))\n"
1542 " (condition \"A.memberOf('board_edge')\")\n"
1543 " (severity ignore))";
1546 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( ruleText );
1548 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1559 "(rule high_current_netclass\n"
1560 " (constraint connection_width (min 0.16mm))\n"
1561 " (condition \"A.NetClass == 'High_current'\"))\n"
1562 "(rule high_current_area\n"
1563 " (constraint connection_width (min 0.16mm))\n"
1564 " (condition \"A.insideArea('high_current')\"))";
1567 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( ruleText );
1569 BOOST_REQUIRE_EQUAL( entries.size(), 2 );
1576 BOOST_CHECK( !entries[0].condition.IsEmpty() );
1577 BOOST_CHECK( !entries[1].condition.IsEmpty() );
1584 wxString originalText =
1586 "(rule ClearanceRule\n"
1587 " (constraint clearance (min 0.2mm))\n"
1588 " (condition \"A.NetClass == 'Power'\"))\n"
1589 "(rule TrackWidthRule\n"
1590 " (constraint track_width (min 0.15mm) (opt 0.2mm) (max 0.3mm)))";
1593 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( originalText );
1595 BOOST_REQUIRE_EQUAL( entries.size(), 2 );
1598 for(
auto& entry : entries )
1599 entry.wasEdited =
true;
1606 std::vector<DRC_RE_LOADED_PANEL_ENTRY> reloadedEntries = loader.
LoadFromString( savedText );
1608 BOOST_REQUIRE_EQUAL( reloadedEntries.size(), 2 );
1622 wxString originalText =
1624 "(rule \"Via Style\"\n"
1625 " (constraint via_diameter (min 0.5mm) (opt 0.6mm) (max 0.8mm))\n"
1626 " (constraint hole_size (min 0.2mm) (opt 0.3mm) (max 0.4mm)))";
1629 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( originalText );
1631 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1634 auto viaData = std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( entries[0].constraintData );
1637 double originalMinDia = viaData->GetMinViaDiameter();
1638 double originalMinHole = viaData->GetMinViaHoleSize();
1641 entries[0].wasEdited =
true;
1646 std::vector<DRC_RE_LOADED_PANEL_ENTRY> reloadedEntries = loader.
LoadFromString( savedText );
1648 BOOST_REQUIRE_EQUAL( reloadedEntries.size(), 1 );
1651 auto reloadedViaData =
1652 std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( reloadedEntries[0].constraintData );
1655 BOOST_CHECK_CLOSE( reloadedViaData->GetMinViaDiameter(), originalMinDia, 0.0001 );
1656 BOOST_CHECK_CLOSE( reloadedViaData->GetMinViaHoleSize(), originalMinHole, 0.0001 );
1664 "(rule \"Rule A\"\n"
1665 " (constraint clearance (min 0.2mm)))\n"
1666 "(rule \"Rule B\"\n"
1667 " (constraint via_diameter (min 0.5mm))\n"
1668 " (constraint hole_size (min 0.2mm))\n"
1669 " (constraint track_width (min 0.15mm)))\n"
1670 "(rule \"Rule C\"\n"
1671 " (constraint edge_clearance (min 0.3mm)))";
1674 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.
LoadFromString( ruleText );
1677 BOOST_REQUIRE_GE( entries.size(), 4 );
1680 int ruleACount = 0, ruleBCount = 0, ruleCCount = 0;
1682 for(
const auto& entry : entries )
1684 if( entry.ruleName ==
"Rule A" )
1686 else if( entry.ruleName ==
"Rule B" )
1688 else if( entry.ruleName ==
"Rule C" )
1693 BOOST_CHECK_GE( ruleBCount, 2 );
1697 int lastAIndex = -1, firstBIndex = entries.size(), lastBIndex = -1, firstCIndex = entries.size();
1699 for(
size_t i = 0; i < entries.size(); i++ )
1701 if( entries[i].ruleName ==
"Rule A" )
1703 else if( entries[i].ruleName ==
"Rule B" )
1705 if( (
int)i < firstBIndex )
1710 else if( entries[i].ruleName ==
"Rule C" )
1712 if( (
int)i < firstCIndex )
1717 BOOST_CHECK( lastAIndex < firstBIndex );
1718 BOOST_CHECK( lastBIndex < firstCIndex );
1730 wxString expr =
"A.NetName == 'VCC'";
1733 BOOST_CHECK( !expr.IsEmpty() );
1734 BOOST_CHECK( expr.Contains(
"NetName" ) );
1735 BOOST_CHECK( expr.Contains(
"VCC" ) );
1741 wxString expr =
"A.NetName == 'VCC' && B.NetClass == 'Power'";
1744 BOOST_CHECK( expr.Contains(
"&&" ) );
1745 BOOST_CHECK( expr.Contains(
"NetName" ) );
1746 BOOST_CHECK( expr.Contains(
"NetClass" ) );
1752 wxString expr =
"A.intersectsArea('underFPGA') || A.intersectsArea('underDDR')";
1755 BOOST_CHECK( expr.Contains(
"||" ) );
1756 BOOST_CHECK( expr.Contains(
"intersectsArea" ) );
1762 wxString expr =
"A.NetClass == 'Power' && !A.intersectsArea('NoRouting')";
1765 BOOST_CHECK( expr.Contains(
"&&" ) );
1766 BOOST_CHECK( expr.Contains(
"!" ) );
1772 wxString expr =
"A.intersectsArea('underFPGA') || A.intersectsArea('underDDR')";
1775 BOOST_CHECK( expr.Contains(
"||" ) );
1776 BOOST_CHECK( expr.Contains(
"underFPGA" ) );
1777 BOOST_CHECK( expr.Contains(
"underDDR" ) );
1783 while( ( pos = expr.find(
"||", pos ) ) != wxString::npos )
1806 for(
KICAD_T type : excludedTypes )
1813 BOOST_CHECK(
true );
1817 BOOST_FAIL(
"Excluded type not handled in filter" );
1822 for(
KICAD_T type : includedTypes )
1829 BOOST_FAIL(
"Included type incorrectly matched by filter" );
1833 BOOST_CHECK(
true );
MINOPTMAX< int > & Value()
Maps DRC rule constraints to appropriate editor panels.
DRC_RULE_EDITOR_CONSTRAINT_NAME GetPanelForConstraint(DRC_CONSTRAINT_T aConstraintType)
Get the panel type for a single constraint.
bool CanPanelLoad(DRC_RULE_EDITOR_CONSTRAINT_NAME aPanel, const std::set< DRC_CONSTRAINT_T > &aConstraints)
Check if a specific panel type can load a set of constraints.
std::vector< DRC_PANEL_MATCH > MatchRule(const DRC_RULE &aRule)
Match a DRC rule to one or more panel types.
VALIDATION_RESULT Validate() const override
Validates the constraint data.
VALIDATION_RESULT Validate() const override
Validates the constraint data.
void SetConstraintCode(wxString aCode)
wxString GetConstraintCode()
wxString GetRuleCondition()
void SetRuleCondition(wxString aRuleCondition)
Simple constraint data object used by custom rules.
void SetRuleText(const wxString &aText)
VALIDATION_RESULT Validate() const override
Validates the constraint data.
VALIDATION_RESULT Validate() const override
Validates the constraint data.
VALIDATION_RESULT Validate() const override
Validates the constraint data.
VALIDATION_RESULT Validate() const override
Validates the constraint data.
double GetMinRoutingWidth()
wxString GenerateRule(const RULE_GENERATION_CONTEXT &aContext) override
double GetMaxRoutingWidth()
VALIDATION_RESULT Validate() const override
Validates the constraint data.
double GetPreferredRoutingWidth()
double GetPreferredViaDiameter()
double GetMaxViaDiameter()
double GetMinViaHoleSize()
double GetMinViaDiameter()
double GetPreferredViaHoleSize()
double GetMaxViaHoleSize()
VALIDATION_RESULT Validate() const override
Validates the constraint data.
wxString GenerateRule(const RULE_GENERATION_CONTEXT &aContext) override
static bool SaveRules(const wxString &aFilename, const std::vector< std::shared_ptr< DRC_RE_BASE_CONSTRAINT_DATA > > &aRules, const BOARD *aBoard)
static void RegisterRuleConverter(RuleConverter aConverter)
static std::vector< std::shared_ptr< DRC_RE_BASE_CONSTRAINT_DATA > > ParseRules(const wxString &aRules)
Loads DRC rules from .kicad_dru files and converts them to panel entries.
std::vector< DRC_RE_LOADED_PANEL_ENTRY > LoadFromString(const wxString &aRulesText)
Load rules from a text string.
Saves DRC panel entries back to .kicad_dru files.
wxString GenerateRulesText(const std::vector< DRC_RE_LOADED_PANEL_ENTRY > &aEntries, const BOARD *aBoard=nullptr)
Generate rule text from panel entries.
void AddConstraint(DRC_CONSTRAINT &aConstraint)
wxString GetRuleName()
Get the name of the rule.
@ VIA_DIAMETER_CONSTRAINT
@ DIFF_PAIR_GAP_CONSTRAINT
@ SILK_CLEARANCE_CONSTRAINT
@ EDGE_CLEARANCE_CONSTRAINT
@ TEXT_THICKNESS_CONSTRAINT
@ MAX_UNCOUPLED_CONSTRAINT
@ HOLE_CLEARANCE_CONSTRAINT
@ HOLE_TO_HOLE_CONSTRAINT
@ MINIMUM_CONNECTION_WIDTH
@ MINIMUM_TEXT_HEIGHT_AND_THICKNESS
@ COPPER_TO_HOLE_CLEARANCE
@ COPPER_TO_EDGE_CLEARANCE
Represents a rule loaded from a .kicad_dru file and mapped to a panel.
wxString originalRuleText
std::shared_ptr< DRC_RE_BASE_CONSTRAINT_DATA > constraintData
DRC_RULE_EDITOR_CONSTRAINT_NAME panelType
wxString conditionExpression
Structure representing a node in a rule tree, collection of this used for building the rule tree.
std::shared_ptr< RULE_EDITOR_DATA_BASE > m_nodeData
Result of a validation operation.
std::vector< std::string > errors
BOOST_AUTO_TEST_CASE(HorizontalAlignment)
BOOST_AUTO_TEST_SUITE(CadstarPartParser)
BOOST_AUTO_TEST_CASE(RoundTripViaStyle)
BOOST_REQUIRE(intersection.has_value()==c.ExpectedIntersection.has_value())
BOOST_AUTO_TEST_SUITE_END()
wxString result
Test unit parsing edge cases and error handling.
BOOST_CHECK_EQUAL(result, "25.4")
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
@ PCB_GENERATOR_T
class PCB_GENERATOR, generator on a layer
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
@ PCB_ZONE_T
class ZONE, a copper pour area
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
@ PCB_PAD_T
class PAD, a pad in a footprint
@ PCB_NETINFO_T
class NETINFO_ITEM, a description of a net
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)