KiCad PCB EDA Suite
Loading...
Searching...
No Matches
test_drc_rule_editor.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#include <boost/test/unit_test.hpp>
25#include <wx/ffile.h>
26#include <core/typeinfo.h>
37#include <drc/drc_rule.h>
45
46BOOST_AUTO_TEST_SUITE( DRC_RULE_EDITOR )
47
48BOOST_AUTO_TEST_CASE( RoundTripViaStyle )
49{
50 DRC_RE_VIA_STYLE_CONSTRAINT_DATA original( 0, 0, "My_Via_Rule", 0.5, 0.8, 0.6, 0.2, 0.4, 0.3 );
51 original.SetConstraintCode( "via_style" );
52 original.SetRuleCondition( "A.NetClass == 'Power'" );
53
55 ctx.ruleName = original.GetRuleName();
57 ctx.constraintCode = original.GetConstraintCode();
58
59 wxString ruleText = original.GenerateRule( ctx );
60
61 auto parsedRules = DRC_RULE_EDITOR_UTILS::ParseRules( ruleText );
62
63 BOOST_REQUIRE_EQUAL( parsedRules.size(), 1 );
64 auto parsed = std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( parsedRules[0] );
65 BOOST_REQUIRE( parsed );
66
67 BOOST_CHECK_EQUAL( parsed->GetRuleName(), original.GetRuleName() );
68 BOOST_CHECK_EQUAL( parsed->GetRuleCondition(), original.GetRuleCondition() );
69 BOOST_CHECK_CLOSE( parsed->GetMinViaDiameter(), original.GetMinViaDiameter(), 0.0001 );
70 BOOST_CHECK_CLOSE( parsed->GetMaxViaDiameter(), original.GetMaxViaDiameter(), 0.0001 );
71 BOOST_CHECK_CLOSE( parsed->GetPreferredViaDiameter(), original.GetPreferredViaDiameter(), 0.0001 );
72 BOOST_CHECK_CLOSE( parsed->GetMinViaHoleSize(), original.GetMinViaHoleSize(), 0.0001 );
73 BOOST_CHECK_CLOSE( parsed->GetMaxViaHoleSize(), original.GetMaxViaHoleSize(), 0.0001 );
74 BOOST_CHECK_CLOSE( parsed->GetPreferredViaHoleSize(), original.GetPreferredViaHoleSize(), 0.0001 );
75}
76
77BOOST_AUTO_TEST_CASE( RoundTripRoutingWidth )
78{
79 DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA original( 0, 0, "My_Track_Rule", 0.2, 0.3, 0.5 );
80 original.SetConstraintCode( "track_width" );
81 original.SetRuleCondition( "A.NetClass == 'Signal'" );
82
84 ctx.ruleName = original.GetRuleName();
86 ctx.constraintCode = original.GetConstraintCode();
87
88 wxString ruleText = original.GenerateRule( ctx );
89
90 auto parsedRules = DRC_RULE_EDITOR_UTILS::ParseRules( ruleText );
91
92 BOOST_REQUIRE_EQUAL( parsedRules.size(), 1 );
93 auto parsed = std::dynamic_pointer_cast<DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA>( parsedRules[0] );
94 BOOST_REQUIRE( parsed );
95
96 BOOST_CHECK_EQUAL( parsed->GetRuleName(), original.GetRuleName() );
97 BOOST_CHECK_EQUAL( parsed->GetRuleCondition(), original.GetRuleCondition() );
98 BOOST_CHECK_CLOSE( parsed->GetMinRoutingWidth(), original.GetMinRoutingWidth(), 0.0001 );
99 BOOST_CHECK_CLOSE( parsed->GetMaxRoutingWidth(), original.GetMaxRoutingWidth(), 0.0001 );
100 BOOST_CHECK_CLOSE( parsed->GetPreferredRoutingWidth(), original.GetPreferredRoutingWidth(), 0.0001 );
101}
102
104{
105 std::vector<std::shared_ptr<DRC_RE_BASE_CONSTRAINT_DATA>> rules;
106
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 );
111
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 );
116
117 wxString filename = "test_rules.dru";
118
119 // We pass nullptr for board, so layers won't be saved, which is fine for this test
120 bool result = DRC_RULE_EDITOR_UTILS::SaveRules( filename, rules, nullptr );
122
123 wxFFile file( filename );
124 BOOST_REQUIRE( file.IsOpened() );
125 wxString content;
126 file.ReadAll( &content );
127
128 // Verify 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" ) );
135
136 // Clean up
137 wxRemoveFile( filename );
138}
139
140BOOST_AUTO_TEST_CASE( SaveRulesToFileLogic )
141{
142 // Mimic m_ruleTreeNodeDatas
143 std::vector<RULE_TREE_NODE> ruleTreeNodeDatas;
144
145 // Add a rule node
146 RULE_TREE_NODE node;
147 node.m_nodeId = 1;
148 node.m_nodeName = "TestRule";
149 node.m_nodeType = RULE; // 4
150
151 auto data = std::make_shared<DRC_RE_BASE_CONSTRAINT_DATA>( 1, 0, "TestRule" );
152 data->SetConstraintCode( "clearance" );
153 node.m_nodeData = data;
154
155 ruleTreeNodeDatas.push_back( node );
156
157 // Mimic SaveRulesToFile logic
158 std::vector<std::shared_ptr<DRC_RE_BASE_CONSTRAINT_DATA>> rules;
159
160 for( const RULE_TREE_NODE& n : ruleTreeNodeDatas )
161 {
162 if( n.m_nodeType != RULE )
163 continue;
164
165 auto d = std::dynamic_pointer_cast<DRC_RE_BASE_CONSTRAINT_DATA>( n.m_nodeData );
166
167 if( d )
168 rules.push_back( d );
169 }
170
171 BOOST_CHECK_EQUAL( rules.size(), 1 );
172}
173
174BOOST_AUTO_TEST_CASE( SaveNumericRules )
175{
176 auto rule = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>( 0, 0, 0.2, "ClearanceRule" );
177 rule->SetConstraintCode( "clearance" );
178
180 ctx.ruleName = rule->GetRuleName();
181 ctx.constraintCode = rule->GetConstraintCode();
182
183 wxString ruleText = rule->GenerateRule( ctx );
184
185 BOOST_CHECK( ruleText.Contains( "(constraint clearance (min 0.2mm))" ) );
186
187 // Test via_count (max, unitless)
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();
191 ctx.constraintCode = rule2->GetConstraintCode();
192
193 ruleText = rule2->GenerateRule( ctx );
194 BOOST_CHECK( ruleText.Contains( "(constraint via_count (max 10))" ) );
195
196 // Test track_angle (min, deg)
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();
200 ctx.constraintCode = rule3->GetConstraintCode();
201
202 ruleText = rule3->GenerateRule( ctx );
203 BOOST_CHECK( ruleText.Contains( "(constraint track_angle (min 45deg))" ) );
204}
205
206BOOST_AUTO_TEST_CASE( SaveBoolRules )
207{
208 auto rule = std::make_shared<DRC_RE_BOOL_INPUT_CONSTRAINT_DATA>( 0, 0, true, "DisallowTestRule" );
209 rule->SetConstraintCode( "disallow" );
210
212 ctx.ruleName = rule->GetRuleName();
213 ctx.constraintCode = rule->GetConstraintCode();
214
215 wxString ruleText = rule->GenerateRule( ctx );
216
217 BOOST_CHECK( ruleText.Contains( "(constraint disallow)" ) );
218
219 // Test false value (should not generate constraint)
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();
223 ctx.constraintCode = rule2->GetConstraintCode();
224
225 ruleText = rule2->GenerateRule( ctx );
226 BOOST_CHECK( ruleText.IsEmpty() );
227}
228
229BOOST_AUTO_TEST_CASE( ParseRulesCategories )
230{
231 wxString rules =
232 "(version 1)\n"
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";
240
241 auto parsedRules = DRC_RULE_EDITOR_UTILS::ParseRules( rules );
242
243 BOOST_REQUIRE_EQUAL( parsedRules.size(), 2 );
244
245 // Check Clearance Rule
246 auto clearanceRule = parsedRules[0];
247 BOOST_CHECK_EQUAL( clearanceRule->GetRuleName(), "Clearance Rule" );
248 BOOST_CHECK_EQUAL( clearanceRule->GetConstraintCode(), "clearance" );
249
250 // Verify it is a numeric constraint data
251 auto numericData = std::dynamic_pointer_cast<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>( clearanceRule );
252 BOOST_REQUIRE( numericData );
253 BOOST_CHECK_CLOSE( numericData->GetNumericInputValue(), 0.2, 0.0001 );
254
255 // Check Via Style Rule
256 auto viaStyleRule = parsedRules[1];
257 BOOST_CHECK_EQUAL( viaStyleRule->GetRuleName(), "Via Style Rule" );
258 BOOST_CHECK_EQUAL( viaStyleRule->GetConstraintCode(), "via_style" );
259
260 auto viaData = std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( viaStyleRule );
261 BOOST_REQUIRE( viaData );
262 BOOST_CHECK_CLOSE( viaData->GetMinViaDiameter(), 0.5, 0.0001 );
263 BOOST_CHECK_CLOSE( viaData->GetMinViaHoleSize(), 0.3, 0.0001 );
264}
265
266BOOST_AUTO_TEST_CASE( FactoryRegistration )
267{
268 // Register a custom parser for 'clearance' to override default
269 bool parserCalled = false;
271 [&]( const std::shared_ptr<DRC_RULE>& aRule ) -> std::shared_ptr<DRC_RE_BASE_CONSTRAINT_DATA>
272 {
273 if( aRule->FindConstraint( CLEARANCE_CONSTRAINT ) )
274 {
275 parserCalled = true;
276 auto data = std::make_shared<DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA>( 0, 0, aRule->m_Name );
277 data->SetConstraintCode( "custom_clearance" );
278 return data;
279 }
280 return nullptr;
281 } );
282
283 wxString ruleText = "(version 1) (rule \"Test Rule\" (constraint clearance (min 1.0mm)) (condition \"A.Type == 'Pad'\"))";
284 auto parsedRules = DRC_RULE_EDITOR_UTILS::ParseRules( ruleText );
285
286 BOOST_CHECK( parserCalled );
287 BOOST_REQUIRE_EQUAL( parsedRules.size(), 1 );
288 BOOST_CHECK_EQUAL( parsedRules[0]->GetConstraintCode(), "custom_clearance" );
289}
290
291BOOST_AUTO_TEST_CASE( ValidateViaStyleValid )
292{
293 DRC_RE_VIA_STYLE_CONSTRAINT_DATA data( 0, 0, "ValidRule", 0.5, 0.8, 0.6, 0.2, 0.4, 0.3 );
294
296
297 BOOST_CHECK( result.isValid );
298 BOOST_CHECK( result.errors.empty() );
299}
300
301BOOST_AUTO_TEST_CASE( ValidateViaStyleInvalidMinGreaterThanMax )
302{
303 // min > max for via diameter
304 DRC_RE_VIA_STYLE_CONSTRAINT_DATA data( 0, 0, "InvalidRule", 0.9, 0.5, 0.6, 0.2, 0.4, 0.3 );
305
307
308 BOOST_CHECK( !result.isValid );
309 BOOST_CHECK( !result.errors.empty() );
310
311 // Should have error about min > max
312 bool foundMinMaxError = false;
313 for( const auto& error : result.errors )
314 {
315 if( error.find( "Minimum Via Diameter cannot be greater than Maximum Via Diameter" ) != std::string::npos )
316 foundMinMaxError = true;
317 }
318 BOOST_CHECK( foundMinMaxError );
319}
320
321BOOST_AUTO_TEST_CASE( ValidateViaStyleInvalidNegativeValues )
322{
323 // Negative values
324 DRC_RE_VIA_STYLE_CONSTRAINT_DATA data( 0, 0, "NegativeRule", -0.5, 0.8, 0.6, 0.2, 0.4, 0.3 );
325
327
328 BOOST_CHECK( !result.isValid );
329 BOOST_CHECK( !result.errors.empty() );
330
331 // Should have error about negative value
332 bool foundNegativeError = false;
333 for( const auto& error : result.errors )
334 {
335 if( error.find( "must be greater than 0" ) != std::string::npos )
336 foundNegativeError = true;
337 }
338 BOOST_CHECK( foundNegativeError );
339}
340
341BOOST_AUTO_TEST_CASE( FactoryOverwrite )
342{
343 // Register a parser
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" );
348 return nullptr;
349 } );
350
351 // Overwrite it (prepend)
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" );
356 return nullptr;
357 } );
358
359 wxString ruleText = "(version 1) (rule \"Test\" (constraint clearance (min 1.0mm)))";
360 auto parsedRules = DRC_RULE_EDITOR_UTILS::ParseRules( ruleText );
361
362 BOOST_REQUIRE_EQUAL( parsedRules.size(), 1 );
363 BOOST_CHECK_EQUAL( parsedRules[0]->GetRuleName(), "Test_2" );
364}
365
366BOOST_AUTO_TEST_CASE( ValidateAbsLengthTwoValid )
367{
368 // Valid: min < opt < max, all positive
369 DRC_RE_ABSOLUTE_LENGTH_TWO_CONSTRAINT_DATA data( 0, 0, 1.0, 3.0, 5.0, "ValidLengthRule" );
370
372
373 BOOST_CHECK( result.isValid );
374 BOOST_CHECK( result.errors.empty() );
375}
376
377BOOST_AUTO_TEST_CASE( ValidateAbsLengthTwoInvalid )
378{
379 // Invalid: min > max
380 DRC_RE_ABSOLUTE_LENGTH_TWO_CONSTRAINT_DATA data1( 0, 0, 5.0, 3.0, 1.0, "InvalidMinMaxRule" );
381
382 VALIDATION_RESULT result1 = data1.Validate();
383
384 BOOST_CHECK( !result1.isValid );
385 BOOST_CHECK( !result1.errors.empty() );
386
387 bool foundMinMaxError = false;
388
389 for( const auto& error : result1.errors )
390 {
391 if( error.find( "Minimum Length cannot be greater than Maximum Length" ) != std::string::npos )
392 foundMinMaxError = true;
393 }
394
395 BOOST_CHECK( foundMinMaxError );
396
397 // Invalid: negative values
398 DRC_RE_ABSOLUTE_LENGTH_TWO_CONSTRAINT_DATA data2( 0, 0, -1.0, 3.0, 5.0, "NegativeMinRule" );
399
400 VALIDATION_RESULT result2 = data2.Validate();
401
402 BOOST_CHECK( !result2.isValid );
403
404 bool foundNegativeError = false;
405
406 for( const auto& error : result2.errors )
407 {
408 if( error.find( "must be greater than 0" ) != std::string::npos )
409 foundNegativeError = true;
410 }
411
412 BOOST_CHECK( foundNegativeError );
413}
414
415BOOST_AUTO_TEST_CASE( ValidateDiffPairValid )
416{
417 // Valid: all positive, min <= preferred <= max for width and gap
418 // Constructor: id, parentId, ruleName, maxUncoupledLength, minWidth, preferredWidth, maxWidth, minGap, preferredGap, maxGap
419 DRC_RE_ROUTING_DIFF_PAIR_CONSTRAINT_DATA data( 0, 0, "ValidDiffPairRule", 10.0, 0.2, 0.3, 0.5, 0.1, 0.15, 0.2 );
420
422
423 BOOST_CHECK( result.isValid );
424 BOOST_CHECK( result.errors.empty() );
425}
426
427BOOST_AUTO_TEST_CASE( ValidateDiffPairInvalid )
428{
429 // Invalid: min width > max width
430 DRC_RE_ROUTING_DIFF_PAIR_CONSTRAINT_DATA data1( 0, 0, "InvalidWidthRule", 10.0, 0.5, 0.3, 0.2, 0.1, 0.15, 0.2 );
431
432 VALIDATION_RESULT result1 = data1.Validate();
433
434 BOOST_CHECK( !result1.isValid );
435 BOOST_CHECK( !result1.errors.empty() );
436
437 bool foundWidthError = false;
438 for( const auto& error : result1.errors )
439 {
440 if( error.find( "Minimum Width cannot be greater than Maximum Width" ) != std::string::npos )
441 foundWidthError = true;
442 }
443 BOOST_CHECK( foundWidthError );
444
445 // Invalid: negative gap
446 DRC_RE_ROUTING_DIFF_PAIR_CONSTRAINT_DATA data2( 0, 0, "NegativeGapRule", 10.0, 0.2, 0.3, 0.5, -0.1, 0.15, 0.2 );
447
448 VALIDATION_RESULT result2 = data2.Validate();
449
450 BOOST_CHECK( !result2.isValid );
451
452 bool foundNegativeError = false;
453 for( const auto& error : result2.errors )
454 {
455 if( error.find( "must be greater than 0" ) != std::string::npos )
456 foundNegativeError = true;
457 }
458 BOOST_CHECK( foundNegativeError );
459}
460
461BOOST_AUTO_TEST_CASE( ValidatePermittedLayersValid )
462{
463 // Valid: at least one layer is selected (top layer enabled)
464 DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA data1( 0, 0, "ValidTopLayerRule", true, false );
465
466 VALIDATION_RESULT result1 = data1.Validate();
467
468 BOOST_CHECK( result1.isValid );
469 BOOST_CHECK( result1.errors.empty() );
470
471 // Valid: at least one layer is selected (bottom layer enabled)
472 DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA data2( 0, 0, "ValidBottomLayerRule", false, true );
473
474 VALIDATION_RESULT result2 = data2.Validate();
475
476 BOOST_CHECK( result2.isValid );
477 BOOST_CHECK( result2.errors.empty() );
478
479 // Valid: both layers enabled
480 DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA data3( 0, 0, "ValidBothLayersRule", true, true );
481
482 VALIDATION_RESULT result3 = data3.Validate();
483
484 BOOST_CHECK( result3.isValid );
485 BOOST_CHECK( result3.errors.empty() );
486}
487
488BOOST_AUTO_TEST_CASE( ValidatePermittedLayersInvalid )
489{
490 // Invalid: no layers selected
491 DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA data( 0, 0, "NoLayersRule", false, false );
492
494
495 BOOST_CHECK( !result.isValid );
496 BOOST_CHECK( !result.errors.empty() );
497
498 bool foundLayerError = false;
499 for( const auto& error : result.errors )
500 {
501 if( error.find( "At least one layer must be selected" ) != std::string::npos )
502 foundLayerError = true;
503 }
504 BOOST_CHECK( foundLayerError );
505}
506
507BOOST_AUTO_TEST_CASE( ValidateNumericInputValid )
508{
509 DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA data( 0, 0, 0.5, "ValidRule" );
510
512
513 BOOST_CHECK( result.isValid );
514 BOOST_CHECK( result.errors.empty() );
515}
516
517BOOST_AUTO_TEST_CASE( ValidateNumericInputInvalidNegative )
518{
519 DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA data( 0, 0, -0.5, "InvalidRule" );
520
522
523 BOOST_CHECK( !result.isValid );
524 BOOST_CHECK( !result.errors.empty() );
525
526 // Should have error about value not being greater than 0
527 bool foundError = false;
528 for( const auto& error : result.errors )
529 {
530 if( error.find( "must be greater than 0" ) != std::string::npos )
531 foundError = true;
532 }
533 BOOST_CHECK( foundError );
534}
535
536BOOST_AUTO_TEST_CASE( ValidateRoutingWidthValid )
537{
538 DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA data( 0, 0, "ValidRule", 0.2, 0.3, 0.5 );
539
541
542 BOOST_CHECK( result.isValid );
543 BOOST_CHECK( result.errors.empty() );
544}
545
546BOOST_AUTO_TEST_CASE( ValidateRoutingWidthInvalidMinGreaterThanMax )
547{
548 // min > max for routing width
549 DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA data( 0, 0, "InvalidRule", 0.9, 0.5, 0.3 );
550
552
553 BOOST_CHECK( !result.isValid );
554 BOOST_CHECK( !result.errors.empty() );
555
556 // Should have error about min > max
557 bool foundMinMaxError = false;
558 for( const auto& error : result.errors )
559 {
560 if( error.find( "Minimum Routing Width cannot be greater than Maximum Routing Width" ) != std::string::npos )
561 foundMinMaxError = true;
562 }
563 BOOST_CHECK( foundMinMaxError );
564}
565
566BOOST_AUTO_TEST_CASE( ValidateAllowedOrientationValid )
567{
568 // Valid: at least one orientation is selected (0 degrees)
569 DRC_RE_ALLOWED_ORIENTATION_CONSTRAINT_DATA data1( 0, 0, true, false, false, false, false, "ValidZeroDegRule" );
570
571 VALIDATION_RESULT result1 = data1.Validate();
572
573 BOOST_CHECK( result1.isValid );
574 BOOST_CHECK( result1.errors.empty() );
575
576 // Valid: 90 degrees selected
577 DRC_RE_ALLOWED_ORIENTATION_CONSTRAINT_DATA data2( 0, 0, false, true, false, false, false, "ValidNinetyDegRule" );
578
579 VALIDATION_RESULT result2 = data2.Validate();
580
581 BOOST_CHECK( result2.isValid );
582 BOOST_CHECK( result2.errors.empty() );
583
584 // Valid: all degrees selected
585 DRC_RE_ALLOWED_ORIENTATION_CONSTRAINT_DATA data3( 0, 0, false, false, false, false, true, "ValidAllDegreesRule" );
586
587 VALIDATION_RESULT result3 = data3.Validate();
588
589 BOOST_CHECK( result3.isValid );
590 BOOST_CHECK( result3.errors.empty() );
591
592 // Valid: multiple orientations selected
593 DRC_RE_ALLOWED_ORIENTATION_CONSTRAINT_DATA data4( 0, 0, true, true, false, false, false, "ValidMultipleRule" );
594
595 VALIDATION_RESULT result4 = data4.Validate();
596
597 BOOST_CHECK( result4.isValid );
598 BOOST_CHECK( result4.errors.empty() );
599}
600
601BOOST_AUTO_TEST_CASE( ValidateAllowedOrientationInvalid )
602{
603 // Invalid: no orientation selected
604 DRC_RE_ALLOWED_ORIENTATION_CONSTRAINT_DATA data( 0, 0, false, false, false, false, false, "NoOrientationRule" );
605
607
608 BOOST_CHECK( !result.isValid );
609 BOOST_CHECK( !result.errors.empty() );
610
611 bool foundOrientationError = false;
612 for( const auto& error : result.errors )
613 {
614 if( error.find( "At least one orientation must be selected" ) != std::string::npos )
615 foundOrientationError = true;
616 }
617 BOOST_CHECK( foundOrientationError );
618}
619
620BOOST_AUTO_TEST_CASE( ValidateBoolInputValid )
621{
622 // Test with true value
623 DRC_RE_BOOL_INPUT_CONSTRAINT_DATA dataTrue( 0, 0, true, "BoolRuleTrue" );
624
625 VALIDATION_RESULT resultTrue = dataTrue.Validate();
626
627 BOOST_CHECK( resultTrue.isValid );
628 BOOST_CHECK( resultTrue.errors.empty() );
629
630 // Test with false value
631 DRC_RE_BOOL_INPUT_CONSTRAINT_DATA dataFalse( 0, 0, false, "BoolRuleFalse" );
632
633 VALIDATION_RESULT resultFalse = dataFalse.Validate();
634
635 BOOST_CHECK( resultFalse.isValid );
636 BOOST_CHECK( resultFalse.errors.empty() );
637}
638
639BOOST_AUTO_TEST_CASE( ValidateMinTxtHtThValid )
640{
641 // Valid: both text height and thickness are positive
642 DRC_RE_MINIMUM_TEXT_HEIGHT_THICKNESS_CONSTRAINT_DATA data( 0, 0, "ValidTextRule", 1.0, 0.15 );
643
645
646 BOOST_CHECK( result.isValid );
647 BOOST_CHECK( result.errors.empty() );
648}
649
650BOOST_AUTO_TEST_CASE( ValidateMinTxtHtThInvalid )
651{
652 // Invalid: negative text height
653 DRC_RE_MINIMUM_TEXT_HEIGHT_THICKNESS_CONSTRAINT_DATA data1( 0, 0, "NegativeHeightRule", -1.0, 0.15 );
654
655 VALIDATION_RESULT result1 = data1.Validate();
656
657 BOOST_CHECK( !result1.isValid );
658 BOOST_CHECK( !result1.errors.empty() );
659
660 bool foundHeightError = false;
661 for( const auto& error : result1.errors )
662 {
663 if( error.find( "Minimum Text Height must be greater than 0" ) != std::string::npos )
664 foundHeightError = true;
665 }
666 BOOST_CHECK( foundHeightError );
667
668 // Invalid: negative text thickness
669 DRC_RE_MINIMUM_TEXT_HEIGHT_THICKNESS_CONSTRAINT_DATA data2( 0, 0, "NegativeThicknessRule", 1.0, -0.15 );
670
671 VALIDATION_RESULT result2 = data2.Validate();
672
673 BOOST_CHECK( !result2.isValid );
674
675 bool foundThicknessError = false;
676 for( const auto& error : result2.errors )
677 {
678 if( error.find( "Minimum Text Thickness must be greater than 0" ) != std::string::npos )
679 foundThicknessError = true;
680 }
681 BOOST_CHECK( foundThicknessError );
682
683 // Invalid: both zero (default values)
685
686 VALIDATION_RESULT result3 = data3.Validate();
687
688 BOOST_CHECK( !result3.isValid );
689 BOOST_CHECK_EQUAL( result3.errors.size(), 2 );
690}
691
692BOOST_AUTO_TEST_CASE( ValidateCustomRuleValid )
693{
694 DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA data( 0, 0, "ValidCustomRule" );
695 data.SetRuleText( "(constraint clearance (min 0.2mm))" );
696
698
699 BOOST_CHECK( result.isValid );
700 BOOST_CHECK( result.errors.empty() );
701}
702
703BOOST_AUTO_TEST_CASE( ValidateCustomRuleInvalid )
704{
705 DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA data( 0, 0, "InvalidCustomRule" );
706 data.SetRuleText( "" );
707
709
710 BOOST_CHECK( !result.isValid );
711 BOOST_CHECK( !result.errors.empty() );
712
713 // Should have error about empty rule text
714 bool foundEmptyError = false;
715 for( const auto& error : result.errors )
716 {
717 if( error.find( "Rule text cannot be empty" ) != std::string::npos )
718 foundEmptyError = true;
719 }
720 BOOST_CHECK( foundEmptyError );
721}
722
723
724// ============================================================================
725// Panel Matcher Tests (Phase 5.1)
726// ============================================================================
727
728BOOST_AUTO_TEST_CASE( PanelMatcherExactMatchViaStyle )
729{
730 // Test: Rule with via_diameter + hole_size → VIA_STYLE panel
731 DRC_RULE rule( "ViaStyleRule" );
732
734 viaDia.Value().SetMin( 500000 );
735 viaDia.Value().SetOpt( 600000 );
736 viaDia.Value().SetMax( 800000 );
737 rule.AddConstraint( viaDia );
738
740 holeSize.Value().SetMin( 200000 );
741 holeSize.Value().SetOpt( 300000 );
742 holeSize.Value().SetMax( 400000 );
743 rule.AddConstraint( holeSize );
744
745 DRC_PANEL_MATCHER matcher;
746 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
747
748 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
749 BOOST_CHECK_EQUAL( matches[0].panelType, VIA_STYLE );
750 BOOST_CHECK_EQUAL( matches[0].claimedConstraints.size(), 2 );
751 BOOST_CHECK( matches[0].claimedConstraints.count( VIA_DIAMETER_CONSTRAINT ) > 0 );
752 BOOST_CHECK( matches[0].claimedConstraints.count( HOLE_SIZE_CONSTRAINT ) > 0 );
753}
754
755BOOST_AUTO_TEST_CASE( PanelMatcherPartialMatchViaDiameter )
756{
757 // Test: Rule with only via_diameter → MINIMUM_VIA_DIAMETER panel
758 DRC_RULE rule( "ViaDiameterOnlyRule" );
759
761 viaDia.Value().SetMin( 500000 );
762 rule.AddConstraint( viaDia );
763
764 DRC_PANEL_MATCHER matcher;
765 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
766
767 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
768 BOOST_CHECK_EQUAL( matches[0].panelType, MINIMUM_VIA_DIAMETER );
769 BOOST_CHECK_EQUAL( matches[0].claimedConstraints.size(), 1 );
770 BOOST_CHECK( matches[0].claimedConstraints.count( VIA_DIAMETER_CONSTRAINT ) > 0 );
771}
772
773BOOST_AUTO_TEST_CASE( PanelMatcherSplitRule )
774{
775 // Test: Rule with via_diameter + hole_size + clearance → 2 panels
776 DRC_RULE rule( "SplitRule" );
777
779 viaDia.Value().SetMin( 500000 );
780 rule.AddConstraint( viaDia );
781
783 holeSize.Value().SetMin( 200000 );
784 rule.AddConstraint( holeSize );
785
787 clearance.Value().SetMin( 150000 );
788 rule.AddConstraint( clearance );
789
790 DRC_PANEL_MATCHER matcher;
791 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
792
793 BOOST_REQUIRE_EQUAL( matches.size(), 2 );
794
795 // VIA_STYLE should claim via_diameter + hole_size
796 BOOST_CHECK_EQUAL( matches[0].panelType, VIA_STYLE );
797 BOOST_CHECK_EQUAL( matches[0].claimedConstraints.size(), 2 );
798
799 // MINIMUM_CLEARANCE should claim clearance
800 BOOST_CHECK_EQUAL( matches[1].panelType, MINIMUM_CLEARANCE );
801 BOOST_CHECK_EQUAL( matches[1].claimedConstraints.size(), 1 );
802 BOOST_CHECK( matches[1].claimedConstraints.count( CLEARANCE_CONSTRAINT ) > 0 );
803}
804
805BOOST_AUTO_TEST_CASE( PanelMatcherPriorityDiffPairOverRoutingWidth )
806{
807 // Test: Rule with track_width + diff_pair_gap → ROUTING_DIFF_PAIR (not ROUTING_WIDTH)
808 DRC_RULE rule( "DiffPairRule" );
809
811 trackWidth.Value().SetMin( 200000 );
812 trackWidth.Value().SetOpt( 250000 );
813 trackWidth.Value().SetMax( 300000 );
814 rule.AddConstraint( trackWidth );
815
817 diffGap.Value().SetMin( 100000 );
818 diffGap.Value().SetOpt( 150000 );
819 diffGap.Value().SetMax( 200000 );
820 rule.AddConstraint( diffGap );
821
822 DRC_PANEL_MATCHER matcher;
823 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
824
825 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
826 BOOST_CHECK_EQUAL( matches[0].panelType, ROUTING_DIFF_PAIR );
827 BOOST_CHECK( matches[0].claimedConstraints.count( TRACK_WIDTH_CONSTRAINT ) > 0 );
828 BOOST_CHECK( matches[0].claimedConstraints.count( DIFF_PAIR_GAP_CONSTRAINT ) > 0 );
829}
830
831BOOST_AUTO_TEST_CASE( PanelMatcherDiffPairWithOptionalUncoupled )
832{
833 // Test: Rule with track_width + diff_pair_gap + uncoupled → ROUTING_DIFF_PAIR claims all three
834 DRC_RULE rule( "DiffPairWithUncoupledRule" );
835
837 trackWidth.Value().SetMin( 200000 );
838 rule.AddConstraint( trackWidth );
839
841 diffGap.Value().SetMin( 100000 );
842 rule.AddConstraint( diffGap );
843
845 uncoupled.Value().SetMax( 5000000 );
846 rule.AddConstraint( uncoupled );
847
848 DRC_PANEL_MATCHER matcher;
849 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
850
851 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
852 BOOST_CHECK_EQUAL( matches[0].panelType, ROUTING_DIFF_PAIR );
853 BOOST_CHECK_EQUAL( matches[0].claimedConstraints.size(), 3 );
854 BOOST_CHECK( matches[0].claimedConstraints.count( TRACK_WIDTH_CONSTRAINT ) > 0 );
855 BOOST_CHECK( matches[0].claimedConstraints.count( DIFF_PAIR_GAP_CONSTRAINT ) > 0 );
856 BOOST_CHECK( matches[0].claimedConstraints.count( MAX_UNCOUPLED_CONSTRAINT ) > 0 );
857}
858
859BOOST_AUTO_TEST_CASE( PanelMatcherTrackWidthOnly )
860{
861 // Test: Rule with only track_width → ROUTING_WIDTH (not ROUTING_DIFF_PAIR)
862 DRC_RULE rule( "TrackWidthOnlyRule" );
863
865 trackWidth.Value().SetMin( 200000 );
866 trackWidth.Value().SetOpt( 250000 );
867 trackWidth.Value().SetMax( 300000 );
868 rule.AddConstraint( trackWidth );
869
870 DRC_PANEL_MATCHER matcher;
871 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
872
873 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
874 BOOST_CHECK_EQUAL( matches[0].panelType, ROUTING_WIDTH );
875 BOOST_CHECK( matches[0].claimedConstraints.count( TRACK_WIDTH_CONSTRAINT ) > 0 );
876}
877
878BOOST_AUTO_TEST_CASE( PanelMatcherTextHeightAndThickness )
879{
880 // Test: Rule with text_height + text_thickness → MINIMUM_TEXT_HEIGHT_AND_THICKNESS
881 DRC_RULE rule( "TextRule" );
882
884 textHeight.Value().SetMin( 1000000 );
885 rule.AddConstraint( textHeight );
886
888 textThickness.Value().SetMin( 150000 );
889 rule.AddConstraint( textThickness );
890
891 DRC_PANEL_MATCHER matcher;
892 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
893
894 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
896 BOOST_CHECK_EQUAL( matches[0].claimedConstraints.size(), 2 );
897}
898
899BOOST_AUTO_TEST_CASE( PanelMatcherLengthConstraint )
900{
901 // Test: Rule with length constraint matches ABSOLUTE_LENGTH panel
902 DRC_RULE rule( "LengthRule" );
903
905 length.Value().SetMin( 10000000 );
906 length.Value().SetOpt( 30000000 );
907 length.Value().SetMax( 50000000 );
908 rule.AddConstraint( length );
909
910 DRC_PANEL_MATCHER matcher;
911 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
912
913 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
914 BOOST_CHECK_EQUAL( matches[0].panelType, ABSOLUTE_LENGTH );
915 BOOST_CHECK( matches[0].claimedConstraints.count( LENGTH_CONSTRAINT ) > 0 );
916}
917
918BOOST_AUTO_TEST_CASE( PanelMatcherEmptyRule )
919{
920 // Test: Rule with no constraints → no matches
921 DRC_RULE rule( "EmptyRule" );
922
923 DRC_PANEL_MATCHER matcher;
924 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
925
926 BOOST_CHECK_EQUAL( matches.size(), 0 );
927}
928
929BOOST_AUTO_TEST_CASE( PanelMatcherCanPanelLoad )
930{
931 DRC_PANEL_MATCHER matcher;
932
933 // VIA_STYLE can load via_diameter + hole_size
934 std::set<DRC_CONSTRAINT_T> viaStyleConstraints = { VIA_DIAMETER_CONSTRAINT, HOLE_SIZE_CONSTRAINT };
935 BOOST_CHECK( matcher.CanPanelLoad( VIA_STYLE, viaStyleConstraints ) );
936
937 // VIA_STYLE cannot load clearance
938 std::set<DRC_CONSTRAINT_T> clearanceConstraint = { CLEARANCE_CONSTRAINT };
939 BOOST_CHECK( !matcher.CanPanelLoad( VIA_STYLE, clearanceConstraint ) );
940
941 // CUSTOM_RULE can load anything
942 BOOST_CHECK( matcher.CanPanelLoad( CUSTOM_RULE, viaStyleConstraints ) );
943 BOOST_CHECK( matcher.CanPanelLoad( CUSTOM_RULE, clearanceConstraint ) );
944}
945
958
959
960// ============================================================================
961// Rule Loader Tests (Phase 5.1)
962// ============================================================================
963
964BOOST_AUTO_TEST_CASE( RuleLoaderViaStyleFromText )
965{
966 // Test: Load a via style rule from text and verify values
967 wxString ruleText =
968 "(version 1)\n"
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)))";
972
973 DRC_RULE_LOADER loader;
974 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
975
976 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
977 BOOST_CHECK_EQUAL( entries[0].panelType, VIA_STYLE );
978 BOOST_CHECK_EQUAL( entries[0].ruleName, "Via Test" );
979
980 auto viaData = std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( entries[0].constraintData );
981 BOOST_REQUIRE( viaData );
982
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 );
989}
990
991BOOST_AUTO_TEST_CASE( RuleLoaderRoutingWidthFromText )
992{
993 // Test: Load a routing width rule from text
994 wxString ruleText =
995 "(version 1)\n"
996 "(rule \"Track Test\"\n"
997 " (constraint track_width (min 0.2mm) (opt 0.25mm) (max 0.3mm)))";
998
999 DRC_RULE_LOADER loader;
1000 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1001
1002 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1003 BOOST_CHECK_EQUAL( entries[0].panelType, ROUTING_WIDTH );
1004 BOOST_CHECK_EQUAL( entries[0].ruleName, "Track Test" );
1005
1006 auto trackData = std::dynamic_pointer_cast<DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA>( entries[0].constraintData );
1007 BOOST_REQUIRE( trackData );
1008
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 );
1012}
1013
1014BOOST_AUTO_TEST_CASE( RuleLoaderDiffPairFromText )
1015{
1016 // Test: Load a diff pair rule from text
1017 wxString ruleText =
1018 "(version 1)\n"
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)))";
1023
1024 DRC_RULE_LOADER loader;
1025 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1026
1027 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1028 BOOST_CHECK_EQUAL( entries[0].panelType, ROUTING_DIFF_PAIR );
1029
1030 auto dpData = std::dynamic_pointer_cast<DRC_RE_ROUTING_DIFF_PAIR_CONSTRAINT_DATA>( entries[0].constraintData );
1031 BOOST_REQUIRE( dpData );
1032
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 );
1040}
1041
1042BOOST_AUTO_TEST_CASE( RuleLoaderSplitRuleFromText )
1043{
1044 // Test: Load a rule that splits into multiple panels
1045 wxString ruleText =
1046 "(version 1)\n"
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)))";
1051
1052 DRC_RULE_LOADER loader;
1053 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1054
1055 BOOST_REQUIRE_EQUAL( entries.size(), 2 );
1056
1057 // First entry should be VIA_STYLE
1058 BOOST_CHECK_EQUAL( entries[0].panelType, VIA_STYLE );
1059 BOOST_CHECK_EQUAL( entries[0].ruleName, "Split Test" );
1060
1061 // Second entry should be MINIMUM_CLEARANCE
1062 BOOST_CHECK_EQUAL( entries[1].panelType, MINIMUM_CLEARANCE );
1063 BOOST_CHECK_EQUAL( entries[1].ruleName, "Split Test" );
1064
1065 auto numericData = std::dynamic_pointer_cast<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>( entries[1].constraintData );
1066 BOOST_REQUIRE( numericData );
1067 BOOST_CHECK_CLOSE( numericData->GetNumericInputValue(), 0.15, 0.0001 );
1068}
1069
1070BOOST_AUTO_TEST_CASE( RuleLoaderVmeWrenClearanceUnderFpga )
1071{
1072 // Test: Load the clearance_under_fpga rule from vme-wren demo which should split
1073 // This rule has: clearance, hole_size, via_diameter
1074 // Should split into: VIA_STYLE (hole_size + via_diameter) + MINIMUM_CLEARANCE (clearance)
1075 wxString ruleText =
1076 "(version 1)\n"
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')\"))";
1082
1083 DRC_RULE_LOADER loader;
1084 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1085
1086 // Should produce 2 entries from the split
1087 BOOST_REQUIRE_EQUAL( entries.size(), 2 );
1088
1089 // First entry should be VIA_STYLE (claims via_diameter + hole_size at priority 90)
1090 BOOST_CHECK_EQUAL( entries[0].panelType, VIA_STYLE );
1091 BOOST_CHECK_EQUAL( entries[0].ruleName, "clearance_under_fpga" );
1092 BOOST_CHECK_EQUAL( entries[0].condition, "A.intersectsArea('underFPGA') || A.intersectsArea('underDDR')" );
1093
1094 // Second entry should be MINIMUM_CLEARANCE (claims clearance at priority 30)
1095 BOOST_CHECK_EQUAL( entries[1].panelType, MINIMUM_CLEARANCE );
1096 BOOST_CHECK_EQUAL( entries[1].ruleName, "clearance_under_fpga" );
1097 BOOST_CHECK_EQUAL( entries[1].condition, "A.intersectsArea('underFPGA') || A.intersectsArea('underDDR')" );
1098
1099 // Verify VIA_STYLE has correct values
1100 auto viaData = std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( entries[0].constraintData );
1101 BOOST_REQUIRE( viaData );
1102 BOOST_CHECK_CLOSE( viaData->GetMinViaDiameter(), 0.4, 0.0001 );
1103 BOOST_CHECK_CLOSE( viaData->GetMinViaHoleSize(), 0.2, 0.0001 );
1104
1105 // Verify MINIMUM_CLEARANCE has correct value
1106 auto clearanceData = std::dynamic_pointer_cast<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>( entries[1].constraintData );
1107 BOOST_REQUIRE( clearanceData );
1108 BOOST_CHECK_CLOSE( clearanceData->GetNumericInputValue(), 0.1, 0.0001 );
1109}
1110
1111BOOST_AUTO_TEST_CASE( RuleLoaderTextHeightThicknessFromText )
1112{
1113 // Test: Load text height and thickness rule
1114 wxString ruleText =
1115 "(version 1)\n"
1116 "(rule \"Text Test\"\n"
1117 " (constraint text_height (min 1mm))\n"
1118 " (constraint text_thickness (min 0.15mm)))";
1119
1120 DRC_RULE_LOADER loader;
1121 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1122
1123 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1125
1126 auto textData = std::dynamic_pointer_cast<DRC_RE_MINIMUM_TEXT_HEIGHT_THICKNESS_CONSTRAINT_DATA>( entries[0].constraintData );
1127 BOOST_REQUIRE( textData );
1128
1129 BOOST_CHECK_CLOSE( textData->GetMinTextHeight(), 1.0, 0.0001 );
1130 BOOST_CHECK_CLOSE( textData->GetMinTextThickness(), 0.15, 0.0001 );
1131}
1132
1133BOOST_AUTO_TEST_CASE( RuleLoaderAbsoluteLengthFromText )
1134{
1135 // Test: Load absolute length rule with min/opt/max
1136 wxString ruleText =
1137 "(version 1)\n"
1138 "(rule \"Length Test\"\n"
1139 " (constraint length (min 10mm) (opt 30mm) (max 50mm)))";
1140
1141 DRC_RULE_LOADER loader;
1142 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1143
1144 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1145 BOOST_CHECK_EQUAL( entries[0].panelType, ABSOLUTE_LENGTH );
1146 BOOST_CHECK_EQUAL( entries[0].ruleName, "Length Test" );
1147
1148 auto lengthData = dynamic_pointer_cast<DRC_RE_ABSOLUTE_LENGTH_TWO_CONSTRAINT_DATA>( entries[0].constraintData );
1149 BOOST_REQUIRE( lengthData );
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 );
1153}
1154
1155BOOST_AUTO_TEST_CASE( RuleLoaderWithCondition )
1156{
1157 // Test: Load rule with condition
1158 wxString ruleText =
1159 "(version 1)\n"
1160 "(rule \"Conditional Test\"\n"
1161 " (condition \"A.NetClass == 'Power'\")\n"
1162 " (constraint clearance (min 0.3mm)))";
1163
1164 DRC_RULE_LOADER loader;
1165 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1166
1167 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1168 BOOST_CHECK_EQUAL( entries[0].ruleName, "Conditional Test" );
1169 BOOST_CHECK_EQUAL( entries[0].condition, "A.NetClass == 'Power'" );
1170 BOOST_CHECK_EQUAL( entries[0].constraintData->GetRuleCondition(), "A.NetClass == 'Power'" );
1171}
1172
1173BOOST_AUTO_TEST_CASE( RuleLoaderMultipleRules )
1174{
1175 // Test: Load multiple rules and verify order preservation
1176 wxString ruleText =
1177 "(version 1)\n"
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)))";
1185
1186 DRC_RULE_LOADER loader;
1187 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1188
1189 BOOST_REQUIRE_EQUAL( entries.size(), 3 );
1190
1191 BOOST_CHECK_EQUAL( entries[0].ruleName, "Rule A" );
1192 BOOST_CHECK_EQUAL( entries[0].panelType, MINIMUM_CLEARANCE );
1193
1194 BOOST_CHECK_EQUAL( entries[1].ruleName, "Rule B" );
1195 BOOST_CHECK_EQUAL( entries[1].panelType, ROUTING_WIDTH );
1196
1197 BOOST_CHECK_EQUAL( entries[2].ruleName, "Rule C" );
1198 BOOST_CHECK_EQUAL( entries[2].panelType, VIA_STYLE );
1199}
1200
1201BOOST_AUTO_TEST_CASE( RuleLoaderEmptyRule )
1202{
1203 // Test: Rule with no constraints creates custom rule fallback
1204 wxString ruleText =
1205 "(version 1)\n"
1206 "(rule \"Empty Rule\")";
1207
1208 DRC_RULE_LOADER loader;
1209 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1210
1211 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1212 BOOST_CHECK_EQUAL( entries[0].panelType, CUSTOM_RULE );
1213 BOOST_CHECK_EQUAL( entries[0].ruleName, "Empty Rule" );
1214}
1215
1216BOOST_AUTO_TEST_CASE( RuleLoaderInvalidText )
1217{
1218 // Test: Invalid rule text returns empty vector
1219 wxString ruleText = "not valid rule text at all";
1220
1221 DRC_RULE_LOADER loader;
1222 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1223
1224 BOOST_CHECK_EQUAL( entries.size(), 0 );
1225}
1226
1227BOOST_AUTO_TEST_CASE( RuleLoaderNumericConstraints )
1228{
1229 // Test various numeric constraints map to correct panels
1230 wxString ruleText =
1231 "(version 1)\n"
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)))";
1238
1239 DRC_RULE_LOADER loader;
1240 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1241
1242 BOOST_REQUIRE_EQUAL( entries.size(), 3 );
1243
1244 BOOST_CHECK_EQUAL( entries[0].panelType, COPPER_TO_EDGE_CLEARANCE );
1245 BOOST_CHECK_EQUAL( entries[1].panelType, COPPER_TO_HOLE_CLEARANCE );
1246 BOOST_CHECK_EQUAL( entries[2].panelType, COURTYARD_CLEARANCE );
1247}
1248
1249
1250// ============================================================================
1251// Rule Saver Tests (Phase 3)
1252// ============================================================================
1253
1254BOOST_AUTO_TEST_CASE( RuleSaverBasicGeneration )
1255{
1256 // Test: Basic rule text generation from panel entry
1259 entry.ruleName = "TestClearance";
1260 entry.wasEdited = true;
1261
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 );
1266 entry.constraintData = numericData;
1267
1268 DRC_RULE_SAVER saver;
1269 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1270 wxString result = saver.GenerateRulesText( entries, nullptr );
1271
1272 BOOST_CHECK( result.Contains( "(version 1)" ) );
1273 BOOST_CHECK( result.Contains( "TestClearance" ) );
1274 BOOST_CHECK( result.Contains( "clearance" ) );
1275}
1276
1277BOOST_AUTO_TEST_CASE( RuleSaverRoundTripPreservation )
1278{
1279 // Test: Original text preserved when not edited
1282 entry.ruleName = "Preserved Rule";
1283 entry.originalRuleText = "(rule \"Preserved Rule\"\n\t(constraint clearance (min 0.5mm)))";
1284 entry.wasEdited = false;
1285
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 );
1290 entry.constraintData = numericData;
1291
1292 DRC_RULE_SAVER saver;
1293 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1294 wxString result = saver.GenerateRulesText( entries, nullptr );
1295
1296 BOOST_CHECK( result.Contains( entry.originalRuleText ) );
1297}
1298
1299BOOST_AUTO_TEST_CASE( RuleSaverEditedRuleRegenerated )
1300{
1301 // Test: Edited rules regenerate from panel data
1304 entry.ruleName = "EditedRule";
1305 entry.originalRuleText = "(rule \"EditedRule\"\n\t(constraint clearance (min 0.5mm)))";
1306 entry.wasEdited = true;
1307
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 );
1312 entry.constraintData = numericData;
1313
1314 DRC_RULE_SAVER saver;
1315 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1316 wxString result = saver.GenerateRulesText( entries, nullptr );
1317
1318 // Original text should NOT be preserved since wasEdited is true
1319 BOOST_CHECK( !result.Contains( "0.5mm" ) );
1320 BOOST_CHECK( result.Contains( "EditedRule" ) );
1321}
1322
1323BOOST_AUTO_TEST_CASE( RuleSaverViaStyleRule )
1324{
1325 // Test: Via style rule generation
1327 entry.panelType = VIA_STYLE;
1328 entry.ruleName = "ViaTest";
1329
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 );
1338 entry.constraintData = viaData;
1339 entry.wasEdited = true;
1340
1341 DRC_RULE_SAVER saver;
1342 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1343 wxString result = saver.GenerateRulesText( entries, nullptr );
1344
1345 BOOST_CHECK( result.Contains( "ViaTest" ) );
1346 BOOST_CHECK( result.Contains( "via_diameter" ) );
1347 BOOST_CHECK( result.Contains( "hole_size" ) );
1348}
1349
1350BOOST_AUTO_TEST_CASE( RuleSaverMultipleEntries )
1351{
1352 // Test: Multiple entries saved in order
1353 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries;
1354
1357 entry1.ruleName = "RuleA";
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 );
1362 entry1.constraintData = data1;
1363 entry1.wasEdited = true;
1364 entries.push_back( entry1 );
1365
1367 entry2.panelType = ROUTING_WIDTH;
1368 entry2.ruleName = "RuleB";
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 );
1374 entry2.constraintData = data2;
1375 entry2.wasEdited = true;
1376 entries.push_back( entry2 );
1377
1378 DRC_RULE_SAVER saver;
1379 wxString result = saver.GenerateRulesText( entries, nullptr );
1380
1381 // Both rules should appear
1382 BOOST_CHECK( result.Contains( "RuleA" ) );
1383 BOOST_CHECK( result.Contains( "RuleB" ) );
1384
1385 // Check order: RuleA should appear before RuleB
1386 size_t posA = result.Find( "RuleA" );
1387 size_t posB = result.Find( "RuleB" );
1388 BOOST_CHECK( posA < posB );
1389}
1390
1391BOOST_AUTO_TEST_CASE( RuleSaverWithCondition )
1392{
1393 // Test: Rule with condition
1396 entry.ruleName = "ConditionalRule";
1397 entry.condition = "A.NetClass == 'Power'";
1398
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 );
1404 entry.constraintData = numericData;
1405 entry.wasEdited = true;
1406
1407 DRC_RULE_SAVER saver;
1408 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1409 wxString result = saver.GenerateRulesText( entries, nullptr );
1410
1411 BOOST_CHECK( result.Contains( "ConditionalRule" ) );
1412 BOOST_CHECK( result.Contains( "condition" ) );
1413 BOOST_CHECK( result.Contains( "Power" ) );
1414}
1415
1416BOOST_AUTO_TEST_CASE( RuleSaverEmptyEntries )
1417{
1418 // Test: Empty entries vector
1419 DRC_RULE_SAVER saver;
1420 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries;
1421 wxString result = saver.GenerateRulesText( entries, nullptr );
1422
1423 BOOST_CHECK( result.Contains( "(version 1)" ) );
1424 // Should have version header but nothing else
1425 BOOST_CHECK_EQUAL( result.Trim(), "(version 1)" );
1426}
1427
1428BOOST_AUTO_TEST_CASE( RuleSaverNullConstraintData )
1429{
1430 // Test: Entry with null constraint data is skipped
1433 entry.ruleName = "Null Data Rule";
1434 entry.constraintData = nullptr;
1435 entry.wasEdited = true;
1436
1437 DRC_RULE_SAVER saver;
1438 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1439 wxString result = saver.GenerateRulesText( entries, nullptr );
1440
1441 // Should have version header but rule text is skipped
1442 BOOST_CHECK( result.Contains( "(version 1)" ) );
1443 BOOST_CHECK( !result.Contains( "Null Data Rule" ) );
1444}
1445
1446BOOST_AUTO_TEST_CASE( RuleSaverLoadSaveRoundTrip )
1447{
1448 // Test: Full round-trip: Load → mark edited → Save → Load produces equivalent data
1449 wxString originalText =
1450 "(version 1)\n"
1451 "(rule \"RoundTripTest\"\n"
1452 " (constraint clearance (min 0.25mm)))";
1453
1454 DRC_RULE_LOADER loader;
1455 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( originalText );
1456
1457 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1458 BOOST_CHECK_EQUAL( entries[0].ruleName, "RoundTripTest" );
1459
1460 // Mark as edited so it regenerates from data (loader doesn't preserve exact original text)
1461 entries[0].wasEdited = true;
1462
1463 // Save
1464 DRC_RULE_SAVER saver;
1465 wxString savedText = saver.GenerateRulesText( entries, nullptr );
1466
1467 // Verify saved text is valid by reloading
1468 std::vector<DRC_RE_LOADED_PANEL_ENTRY> reloadedEntries = loader.LoadFromString( savedText );
1469
1470 BOOST_REQUIRE_EQUAL( reloadedEntries.size(), 1 );
1471 BOOST_CHECK_EQUAL( reloadedEntries[0].ruleName, "RoundTripTest" );
1472 BOOST_CHECK_EQUAL( reloadedEntries[0].panelType, entries[0].panelType );
1473}
1474
1475BOOST_AUTO_TEST_CASE( RuleSaverDiffPairRule )
1476{
1477 // Test: Diff pair rule generation
1480 entry.ruleName = "DiffPairTest";
1481
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 );
1491 entry.constraintData = dpData;
1492 entry.wasEdited = true;
1493
1494 DRC_RULE_SAVER saver;
1495 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1496 wxString result = saver.GenerateRulesText( entries, nullptr );
1497
1498 BOOST_CHECK( result.Contains( "DiffPairTest" ) );
1499 BOOST_CHECK( result.Contains( "track_width" ) );
1500 BOOST_CHECK( result.Contains( "diff_pair_gap" ) );
1501}
1502
1503
1504// ============================================================================
1505// Integration Tests (Phase 5.2)
1506// ============================================================================
1507
1508BOOST_AUTO_TEST_CASE( IntegrationLoadHoleClearanceRules )
1509{
1510 // Test: Load issue6879.kicad_dru which has hole_clearance and hole constraints
1511 wxString ruleText =
1512 "(version 1)\n"
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'\"))";
1519
1520 DRC_RULE_LOADER loader;
1521 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1522
1523 BOOST_REQUIRE_GE( entries.size(), 2 );
1524
1525 // First rule should be COPPER_TO_HOLE_CLEARANCE
1526 BOOST_CHECK_EQUAL( entries[0].panelType, COPPER_TO_HOLE_CLEARANCE );
1527 BOOST_CHECK_EQUAL( entries[0].ruleName, "PTH to Track Clearance" );
1528 BOOST_CHECK( !entries[0].condition.IsEmpty() );
1529
1530 // Second rule should be HOLE_SIZE
1531 BOOST_CHECK_EQUAL( entries[1].panelType, HOLE_SIZE );
1532 BOOST_CHECK_EQUAL( entries[1].ruleName, "Max Drill Hole Size Mechanical" );
1533}
1534
1535BOOST_AUTO_TEST_CASE( IntegrationLoadEdgeClearanceWithSeverity )
1536{
1537 // Test: Load severities.kicad_dru which has severity clause
1538 wxString ruleText =
1539 "(version 1)\n"
1540 "(rule board_edge\n"
1541 " (constraint edge_clearance (min 1mm))\n"
1542 " (condition \"A.memberOf('board_edge')\")\n"
1543 " (severity ignore))";
1544
1545 DRC_RULE_LOADER loader;
1546 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1547
1548 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1549 BOOST_CHECK_EQUAL( entries[0].panelType, COPPER_TO_EDGE_CLEARANCE );
1550 BOOST_CHECK_EQUAL( entries[0].ruleName, "board_edge" );
1551 BOOST_CHECK_EQUAL( entries[0].severity, RPT_SEVERITY_IGNORE );
1552}
1553
1554BOOST_AUTO_TEST_CASE( IntegrationLoadConnectionWidthRules )
1555{
1556 // Test: Load connection_width_rules.kicad_dru
1557 wxString ruleText =
1558 "(version 1)\n"
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')\"))";
1565
1566 DRC_RULE_LOADER loader;
1567 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1568
1569 BOOST_REQUIRE_EQUAL( entries.size(), 2 );
1570
1571 // Both should be MINIMUM_CONNECTION_WIDTH
1572 BOOST_CHECK_EQUAL( entries[0].panelType, MINIMUM_CONNECTION_WIDTH );
1573 BOOST_CHECK_EQUAL( entries[1].panelType, MINIMUM_CONNECTION_WIDTH );
1574
1575 // Both should have conditions
1576 BOOST_CHECK( !entries[0].condition.IsEmpty() );
1577 BOOST_CHECK( !entries[1].condition.IsEmpty() );
1578}
1579
1580BOOST_AUTO_TEST_CASE( IntegrationSaveLoadRoundTripMultipleRules )
1581{
1582 // Test: Load multiple rules, save, reload - verify equivalent data
1583 // Use rule names without spaces to avoid sanitization differences
1584 wxString originalText =
1585 "(version 1)\n"
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)))";
1591
1592 DRC_RULE_LOADER loader;
1593 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( originalText );
1594
1595 BOOST_REQUIRE_EQUAL( entries.size(), 2 );
1596
1597 // Mark as edited to force regeneration
1598 for( auto& entry : entries )
1599 entry.wasEdited = true;
1600
1601 // Save
1602 DRC_RULE_SAVER saver;
1603 wxString savedText = saver.GenerateRulesText( entries, nullptr );
1604
1605 // Reload
1606 std::vector<DRC_RE_LOADED_PANEL_ENTRY> reloadedEntries = loader.LoadFromString( savedText );
1607
1608 BOOST_REQUIRE_EQUAL( reloadedEntries.size(), 2 );
1609
1610 // Verify panel types preserved correctly
1611 BOOST_CHECK_EQUAL( reloadedEntries[0].panelType, entries[0].panelType );
1612 BOOST_CHECK_EQUAL( reloadedEntries[1].panelType, entries[1].panelType );
1613
1614 // Verify rule names preserved
1615 BOOST_CHECK_EQUAL( reloadedEntries[0].ruleName, "ClearanceRule" );
1616 BOOST_CHECK_EQUAL( reloadedEntries[1].ruleName, "TrackWidthRule" );
1617}
1618
1619BOOST_AUTO_TEST_CASE( IntegrationSaveLoadViaStyleRoundTrip )
1620{
1621 // Test: Via style rules round-trip correctly
1622 wxString originalText =
1623 "(version 1)\n"
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)))";
1627
1628 DRC_RULE_LOADER loader;
1629 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( originalText );
1630
1631 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1632 BOOST_CHECK_EQUAL( entries[0].panelType, VIA_STYLE );
1633
1634 auto viaData = std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( entries[0].constraintData );
1635 BOOST_REQUIRE( viaData );
1636
1637 double originalMinDia = viaData->GetMinViaDiameter();
1638 double originalMinHole = viaData->GetMinViaHoleSize();
1639
1640 // Mark as edited and save
1641 entries[0].wasEdited = true;
1642 DRC_RULE_SAVER saver;
1643 wxString savedText = saver.GenerateRulesText( entries, nullptr );
1644
1645 // Reload and verify values preserved
1646 std::vector<DRC_RE_LOADED_PANEL_ENTRY> reloadedEntries = loader.LoadFromString( savedText );
1647
1648 BOOST_REQUIRE_EQUAL( reloadedEntries.size(), 1 );
1649 BOOST_CHECK_EQUAL( reloadedEntries[0].panelType, VIA_STYLE );
1650
1651 auto reloadedViaData =
1652 std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( reloadedEntries[0].constraintData );
1653 BOOST_REQUIRE( reloadedViaData );
1654
1655 BOOST_CHECK_CLOSE( reloadedViaData->GetMinViaDiameter(), originalMinDia, 0.0001 );
1656 BOOST_CHECK_CLOSE( reloadedViaData->GetMinViaHoleSize(), originalMinHole, 0.0001 );
1657}
1658
1659BOOST_AUTO_TEST_CASE( IntegrationSplitRulePreservesOrder )
1660{
1661 // Test: A rule with multiple constraint types splits and preserves order
1662 wxString ruleText =
1663 "(version 1)\n"
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)))";
1672
1673 DRC_RULE_LOADER loader;
1674 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1675
1676 // Rule B splits into VIA_STYLE and ROUTING_WIDTH
1677 BOOST_REQUIRE_GE( entries.size(), 4 );
1678
1679 // Find entries by rule name
1680 int ruleACount = 0, ruleBCount = 0, ruleCCount = 0;
1681
1682 for( const auto& entry : entries )
1683 {
1684 if( entry.ruleName == "Rule A" )
1685 ruleACount++;
1686 else if( entry.ruleName == "Rule B" )
1687 ruleBCount++;
1688 else if( entry.ruleName == "Rule C" )
1689 ruleCCount++;
1690 }
1691
1692 BOOST_CHECK_EQUAL( ruleACount, 1 );
1693 BOOST_CHECK_GE( ruleBCount, 2 );
1694 BOOST_CHECK_EQUAL( ruleCCount, 1 );
1695
1696 // Verify original order: all Rule A entries before Rule B, Rule B before Rule C
1697 int lastAIndex = -1, firstBIndex = entries.size(), lastBIndex = -1, firstCIndex = entries.size();
1698
1699 for( size_t i = 0; i < entries.size(); i++ )
1700 {
1701 if( entries[i].ruleName == "Rule A" )
1702 lastAIndex = i;
1703 else if( entries[i].ruleName == "Rule B" )
1704 {
1705 if( (int)i < firstBIndex )
1706 firstBIndex = i;
1707
1708 lastBIndex = i;
1709 }
1710 else if( entries[i].ruleName == "Rule C" )
1711 {
1712 if( (int)i < firstCIndex )
1713 firstCIndex = i;
1714 }
1715 }
1716
1717 BOOST_CHECK( lastAIndex < firstBIndex );
1718 BOOST_CHECK( lastBIndex < firstCIndex );
1719}
1720
1721
1722// ============================================================================
1723// Condition Group Panel Tests
1724// ============================================================================
1725
1726BOOST_AUTO_TEST_CASE( ConditionGroupBuildSingleCondition )
1727{
1728 // Test: Single condition builds correctly
1729 // This tests the expression building logic used by DRC_RE_CONDITION_GROUP_PANEL
1730 wxString expr = "A.NetName == 'VCC'";
1731
1732 // When parsed and rebuilt, the result should be equivalent
1733 BOOST_CHECK( !expr.IsEmpty() );
1734 BOOST_CHECK( expr.Contains( "NetName" ) );
1735 BOOST_CHECK( expr.Contains( "VCC" ) );
1736}
1737
1738BOOST_AUTO_TEST_CASE( ConditionGroupTokenizeAndOperator )
1739{
1740 // Test: Tokenizing conditions with AND operator
1741 wxString expr = "A.NetName == 'VCC' && B.NetClass == 'Power'";
1742
1743 // Verify the expression contains expected operators
1744 BOOST_CHECK( expr.Contains( "&&" ) );
1745 BOOST_CHECK( expr.Contains( "NetName" ) );
1746 BOOST_CHECK( expr.Contains( "NetClass" ) );
1747}
1748
1749BOOST_AUTO_TEST_CASE( ConditionGroupTokenizeOrOperator )
1750{
1751 // Test: Tokenizing conditions with OR operator
1752 wxString expr = "A.intersectsArea('underFPGA') || A.intersectsArea('underDDR')";
1753
1754 // Verify the expression contains expected operators
1755 BOOST_CHECK( expr.Contains( "||" ) );
1756 BOOST_CHECK( expr.Contains( "intersectsArea" ) );
1757}
1758
1759BOOST_AUTO_TEST_CASE( ConditionGroupTokenizeAndNotOperator )
1760{
1761 // Test: Tokenizing conditions with AND NOT operator
1762 wxString expr = "A.NetClass == 'Power' && !A.intersectsArea('NoRouting')";
1763
1764 // Verify the expression contains expected operators and negation
1765 BOOST_CHECK( expr.Contains( "&&" ) );
1766 BOOST_CHECK( expr.Contains( "!" ) );
1767}
1768
1769BOOST_AUTO_TEST_CASE( ConditionGroupTokenizeComplexExpression )
1770{
1771 // Test: Complex expression from vme-wren.kicad_dru
1772 wxString expr = "A.intersectsArea('underFPGA') || A.intersectsArea('underDDR')";
1773
1774 // The expression should contain the expected patterns
1775 BOOST_CHECK( expr.Contains( "||" ) );
1776 BOOST_CHECK( expr.Contains( "underFPGA" ) );
1777 BOOST_CHECK( expr.Contains( "underDDR" ) );
1778
1779 // Count number of conditions (2 in this case)
1780 size_t orCount = 0;
1781 size_t pos = 0;
1782
1783 while( ( pos = expr.find( "||", pos ) ) != wxString::npos )
1784 {
1785 orCount++;
1786 pos += 2;
1787 }
1788
1789 BOOST_CHECK_EQUAL( orCount, 1 );
1790}
1791
1792
1793// ============================================================================
1794// DRC Engine Item Filtering Tests
1795// ============================================================================
1796
1797BOOST_AUTO_TEST_CASE( ItemFilterExcludesNetInfoAndGenerator )
1798{
1799 // Test: Verify the item type filter logic matches expected exclusions
1800 // This is a unit test for the switch statement in GetItemsMatchingCondition
1801
1802 std::vector<KICAD_T> excludedTypes = { PCB_NETINFO_T, PCB_GENERATOR_T, PCB_GROUP_T };
1803 std::vector<KICAD_T> includedTypes = { PCB_TRACE_T, PCB_VIA_T, PCB_PAD_T, PCB_FOOTPRINT_T,
1805
1806 for( KICAD_T type : excludedTypes )
1807 {
1808 switch( type )
1809 {
1810 case PCB_NETINFO_T:
1811 case PCB_GENERATOR_T:
1812 case PCB_GROUP_T:
1813 BOOST_CHECK( true ); // These should be excluded (continue in real code)
1814 break;
1815
1816 default:
1817 BOOST_FAIL( "Excluded type not handled in filter" );
1818 break;
1819 }
1820 }
1821
1822 for( KICAD_T type : includedTypes )
1823 {
1824 switch( type )
1825 {
1826 case PCB_NETINFO_T:
1827 case PCB_GENERATOR_T:
1828 case PCB_GROUP_T:
1829 BOOST_FAIL( "Included type incorrectly matched by filter" );
1830 break;
1831
1832 default:
1833 BOOST_CHECK( true ); // These should be included
1834 break;
1835 }
1836 }
1837}
1838
MINOPTMAX< int > & Value()
Definition drc_rule.h:187
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 SetRuleCondition(wxString aRuleCondition)
VALIDATION_RESULT Validate() const override
Validates the constraint data.
Simple constraint data object used by custom rules.
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.
VALIDATION_RESULT Validate() const override
Validates the constraint data.
wxString GenerateRule(const RULE_GENERATION_CONTEXT &aContext) override
VALIDATION_RESULT Validate() const override
Validates the constraint data.
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)
Definition drc_rule.cpp:60
void SetMin(T v)
Definition minoptmax.h:41
void SetOpt(T v)
Definition minoptmax.h:43
void SetMax(T v)
Definition minoptmax.h:42
wxString GetRuleName()
Get the name of the rule.
@ VIA_DIAMETER_CONSTRAINT
Definition drc_rule.h:70
@ DIFF_PAIR_GAP_CONSTRAINT
Definition drc_rule.h:73
@ TRACK_WIDTH_CONSTRAINT
Definition drc_rule.h:59
@ SILK_CLEARANCE_CONSTRAINT
Definition drc_rule.h:56
@ EDGE_CLEARANCE_CONSTRAINT
Definition drc_rule.h:53
@ TEXT_THICKNESS_CONSTRAINT
Definition drc_rule.h:58
@ LENGTH_CONSTRAINT
Definition drc_rule.h:71
@ CLEARANCE_CONSTRAINT
Definition drc_rule.h:49
@ MAX_UNCOUPLED_CONSTRAINT
Definition drc_rule.h:74
@ HOLE_CLEARANCE_CONSTRAINT
Definition drc_rule.h:51
@ HOLE_SIZE_CONSTRAINT
Definition drc_rule.h:54
@ TEXT_HEIGHT_CONSTRAINT
Definition drc_rule.h:57
@ HOLE_TO_HOLE_CONSTRAINT
Definition drc_rule.h:52
@ SILK_TO_SILK_CLEARANCE
@ ROUTING_DIFF_PAIR
@ HOLE_TO_HOLE_CLEARANCE
@ COURTYARD_CLEARANCE
@ MINIMUM_CONNECTION_WIDTH
@ ABSOLUTE_LENGTH
@ MINIMUM_CLEARANCE
@ MINIMUM_TEXT_HEIGHT_AND_THICKNESS
@ COPPER_TO_HOLE_CLEARANCE
@ COPPER_TO_EDGE_CLEARANCE
@ MINIMUM_VIA_DIAMETER
@ RPT_SEVERITY_IGNORE
Represents a rule loaded from a .kicad_dru file and mapped to a panel.
wxString ruleName
wxString originalRuleText
wxString condition
bool wasEdited
std::shared_ptr< DRC_RE_BASE_CONSTRAINT_DATA > constraintData
DRC_RULE_EDITOR_CONSTRAINT_NAME panelType
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()
int clearance
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.
Definition typeinfo.h:78
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
Definition typeinfo.h:88
@ PCB_GENERATOR_T
class PCB_GENERATOR, generator on a layer
Definition typeinfo.h:91
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition typeinfo.h:97
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
Definition typeinfo.h:111
@ PCB_ZONE_T
class ZONE, a copper pour area
Definition typeinfo.h:108
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition typeinfo.h:92
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition typeinfo.h:86
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition typeinfo.h:87
@ PCB_NETINFO_T
class NETINFO_ITEM, a description of a net
Definition typeinfo.h:110
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition typeinfo.h:96