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, see <https://www.gnu.org/licenses/>.
18 */
19
20#include <boost/test/unit_test.hpp>
21#include <wx/ffile.h>
22#include <board.h>
23#include <core/typeinfo.h>
35#include <drc/drc_rule.h>
43#include <drc/drc_engine.h>
46#include <footprint.h>
47
48BOOST_AUTO_TEST_SUITE( DRC_RULE_EDITOR )
49
50BOOST_AUTO_TEST_CASE( RoundTripViaStyle )
51{
52 DRC_RE_VIA_STYLE_CONSTRAINT_DATA original( 0, 0, "My_Via_Rule", 0.5, 0.8, 0.2, 0.4 );
53 original.SetConstraintCode( "via_style" );
54 original.SetRuleCondition( "A.NetClass == 'Power'" );
55
57 ctx.ruleName = original.GetRuleName();
59 ctx.constraintCode = original.GetConstraintCode();
60
61 wxString ruleText = original.GenerateRule( ctx );
62
63 auto parsedRules = DRC_RULE_EDITOR_UTILS::ParseRules( ruleText );
64
65 BOOST_REQUIRE_EQUAL( parsedRules.size(), 1 );
66 auto parsed = std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( parsedRules[0] );
67 BOOST_REQUIRE( parsed );
68
69 BOOST_CHECK_EQUAL( parsed->GetRuleName(), original.GetRuleName() );
70 BOOST_CHECK_EQUAL( parsed->GetRuleCondition(), original.GetRuleCondition() );
71 BOOST_CHECK_CLOSE( parsed->GetMinViaDiameter(), original.GetMinViaDiameter(), 0.0001 );
72 BOOST_CHECK_CLOSE( parsed->GetMaxViaDiameter(), original.GetMaxViaDiameter(), 0.0001 );
73 BOOST_CHECK_CLOSE( parsed->GetMinViaHoleSize(), original.GetMinViaHoleSize(), 0.0001 );
74 BOOST_CHECK_CLOSE( parsed->GetMaxViaHoleSize(), original.GetMaxViaHoleSize(), 0.0001 );
75}
76
77
78BOOST_AUTO_TEST_CASE( ShowMatchesIgnoresPairTokensInStringLiterals )
79{
80 BOARD board;
81
82 FOOTPRINT* footprint = new FOOTPRINT( &board );
83 footprint->SetReference( wxT( "B.Width" ) );
84 board.Add( footprint );
85
86 auto rule = std::make_shared<DRC_RULE>( wxT( "String literal" ) );
87 rule->m_Condition = new DRC_RULE_CONDITION( wxT( "A.Reference == 'B.Width'" ) );
88 BOOST_REQUIRE( rule->m_Condition->Compile( nullptr ) );
89
91 rule->AddConstraint( constraint );
92
93 DRC_ENGINE engine( &board, &board.GetDesignSettings() );
94 std::vector<BOARD_ITEM*> matches = engine.GetItemsMatchingRule( rule, nullptr );
95
96 BOOST_REQUIRE_EQUAL( matches.size(), 1u );
97 BOOST_CHECK_EQUAL( matches.front(), footprint );
98}
99
100
101BOOST_AUTO_TEST_CASE( RoundTripRoutingWidth )
102{
103 DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA original( 0, 0, "My_Track_Rule", 0.3, 0.1 );
104 original.SetConstraintCode( "track_width" );
105 original.SetRuleCondition( "A.NetClass == 'Signal'" );
106
108 ctx.ruleName = original.GetRuleName();
109 ctx.conditionExpression = original.GetRuleCondition();
110 ctx.constraintCode = original.GetConstraintCode();
111
112 wxString ruleText = original.GenerateRule( ctx );
113
114 auto parsedRules = DRC_RULE_EDITOR_UTILS::ParseRules( ruleText );
115
116 BOOST_REQUIRE_EQUAL( parsedRules.size(), 1 );
117 auto parsed = std::dynamic_pointer_cast<DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA>( parsedRules[0] );
118 BOOST_REQUIRE( parsed );
119
120 BOOST_CHECK_EQUAL( parsed->GetRuleName(), original.GetRuleName() );
121 BOOST_CHECK_EQUAL( parsed->GetRuleCondition(), original.GetRuleCondition() );
122 BOOST_CHECK_CLOSE( parsed->GetOptWidth(), original.GetOptWidth(), 0.0001 );
123 BOOST_CHECK_CLOSE( parsed->GetWidthTolerance(), original.GetWidthTolerance(), 0.0001 );
124}
125
127{
128 std::vector<std::shared_ptr<DRC_RE_BASE_CONSTRAINT_DATA>> rules;
129
130 auto rule1 = std::make_shared<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( 0, 0, "ViaRule", 0.5, 0.8, 0.2, 0.4 );
131 rule1->SetConstraintCode( "via_style" );
132 rule1->SetRuleCondition( "A.NetClass == 'Power'" );
133 rules.push_back( rule1 );
134
135 auto rule2 = std::make_shared<DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA>( 0, 0, "TrackRule", 0.3, 0.1 );
136 rule2->SetConstraintCode( "track_width" );
137 rule2->SetRuleCondition( "A.NetClass == 'Signal'" );
138 rules.push_back( rule2 );
139
140 wxString filename = "test_rules.dru";
141
142 // We pass nullptr for board, so layers won't be saved, which is fine for this test
143 bool result = DRC_RULE_EDITOR_UTILS::SaveRules( filename, rules, nullptr );
145
146 wxFFile file( filename );
147 BOOST_REQUIRE( file.IsOpened() );
148 wxString content;
149 file.ReadAll( &content );
150
151 // Verify content
152 BOOST_CHECK( content.Contains( "(version 2)" ) );
153 BOOST_CHECK( content.Contains( "(rule ViaRule" ) );
154 BOOST_CHECK( content.Contains( "(constraint via_diameter" ) );
155 BOOST_CHECK( content.Contains( "(constraint hole_size" ) );
156 BOOST_CHECK( content.Contains( "(rule TrackRule" ) );
157 BOOST_CHECK( content.Contains( "(constraint track_width" ) );
158
159 // Clean up
160 wxRemoveFile( filename );
161}
162
163BOOST_AUTO_TEST_CASE( SaveRulesToFileLogic )
164{
165 // Mimic m_ruleTreeNodeDatas
166 std::vector<RULE_TREE_NODE> ruleTreeNodeDatas;
167
168 // Add a rule node
169 RULE_TREE_NODE node;
170 node.m_nodeId = 1;
171 node.m_nodeName = "TestRule";
172 node.m_nodeType = RULE; // 4
173
174 auto data = std::make_shared<DRC_RE_BASE_CONSTRAINT_DATA>( 1, 0, "TestRule" );
175 data->SetConstraintCode( "clearance" );
176 node.m_nodeData = data;
177
178 ruleTreeNodeDatas.push_back( node );
179
180 // Mimic SaveRulesToFile logic
181 std::vector<std::shared_ptr<DRC_RE_BASE_CONSTRAINT_DATA>> rules;
182
183 for( const RULE_TREE_NODE& n : ruleTreeNodeDatas )
184 {
185 if( n.m_nodeType != RULE )
186 continue;
187
188 auto d = std::dynamic_pointer_cast<DRC_RE_BASE_CONSTRAINT_DATA>( n.m_nodeData );
189
190 if( d )
191 rules.push_back( d );
192 }
193
194 BOOST_CHECK_EQUAL( rules.size(), 1 );
195}
196
197BOOST_AUTO_TEST_CASE( SaveNumericRules )
198{
199 auto rule = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>( 0, 0, 0.2, "ClearanceRule" );
200 rule->SetConstraintCode( "clearance" );
201
203 ctx.ruleName = rule->GetRuleName();
204 ctx.constraintCode = rule->GetConstraintCode();
205
206 wxString ruleText = rule->GenerateRule( ctx );
207
208 BOOST_CHECK( ruleText.Contains( "(constraint clearance (min 0.2mm))" ) );
209
210 // Test via_count (max, unitless)
211 auto rule2 = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>( 0, 0, 10, "ViaCountRule" );
212 rule2->SetConstraintCode( "via_count" );
213 ctx.ruleName = rule2->GetRuleName();
214 ctx.constraintCode = rule2->GetConstraintCode();
215
216 ruleText = rule2->GenerateRule( ctx );
217 BOOST_CHECK( ruleText.Contains( "(constraint via_count (max 10))" ) );
218
219 // Test track_angle (min, deg)
220 auto rule3 = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>( 0, 0, 45, "AngleRule" );
221 rule3->SetConstraintCode( "track_angle" );
222 ctx.ruleName = rule3->GetRuleName();
223 ctx.constraintCode = rule3->GetConstraintCode();
224
225 ruleText = rule3->GenerateRule( ctx );
226 BOOST_CHECK( ruleText.Contains( "(constraint track_angle (min 45deg))" ) );
227}
228
229BOOST_AUTO_TEST_CASE( SaveBoolRules )
230{
231 auto rule = std::make_shared<DRC_RE_BOOL_INPUT_CONSTRAINT_DATA>( 0, 0, true, "DisallowTestRule" );
232 rule->SetConstraintCode( "disallow" );
233
235 ctx.ruleName = rule->GetRuleName();
236 ctx.constraintCode = rule->GetConstraintCode();
237
238 wxString ruleText = rule->GenerateRule( ctx );
239
240 BOOST_CHECK( ruleText.Contains( "(constraint disallow)" ) );
241
242 // Test false value (should not generate constraint)
243 auto rule2 = std::make_shared<DRC_RE_BOOL_INPUT_CONSTRAINT_DATA>( 0, 0, false, "NoDisallowTestRule" );
244 rule2->SetConstraintCode( "disallow" );
245 ctx.ruleName = rule2->GetRuleName();
246 ctx.constraintCode = rule2->GetConstraintCode();
247
248 ruleText = rule2->GenerateRule( ctx );
249 BOOST_CHECK( ruleText.IsEmpty() );
250}
251
252BOOST_AUTO_TEST_CASE( ParseRulesCategories )
253{
254 wxString rules =
255 "(version 1)\n"
256 "(rule \"Clearance Rule\"\n"
257 "\t(constraint clearance (min 0.2mm))\n"
258 "\t(condition \"A.NetClass == 'Power'\"))\n"
259 "(rule \"Via Style Rule\"\n"
260 "\t(constraint via_diameter (min 0.5mm))\n"
261 "\t(constraint hole_size (min 0.3mm))\n"
262 "\t(condition \"A.NetClass == 'Power'\"))\n";
263
264 auto parsedRules = DRC_RULE_EDITOR_UTILS::ParseRules( rules );
265
266 BOOST_REQUIRE_EQUAL( parsedRules.size(), 2 );
267
268 // Check Clearance Rule
269 auto clearanceRule = parsedRules[0];
270 BOOST_CHECK_EQUAL( clearanceRule->GetRuleName(), "Clearance Rule" );
271 BOOST_CHECK_EQUAL( clearanceRule->GetConstraintCode(), "clearance" );
272
273 // Verify it is a numeric constraint data
274 auto numericData = std::dynamic_pointer_cast<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>( clearanceRule );
275 BOOST_REQUIRE( numericData );
276 BOOST_CHECK_CLOSE( numericData->GetNumericInputValue(), 0.2, 0.0001 );
277
278 // Check Via Style Rule
279 auto viaStyleRule = parsedRules[1];
280 BOOST_CHECK_EQUAL( viaStyleRule->GetRuleName(), "Via Style Rule" );
281 BOOST_CHECK_EQUAL( viaStyleRule->GetConstraintCode(), "via_style" );
282
283 auto viaData = std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( viaStyleRule );
284 BOOST_REQUIRE( viaData );
285 BOOST_CHECK_CLOSE( viaData->GetMinViaDiameter(), 0.5, 0.0001 );
286 BOOST_CHECK_CLOSE( viaData->GetMinViaHoleSize(), 0.3, 0.0001 );
287}
288
289BOOST_AUTO_TEST_CASE( FactoryRegistration )
290{
291 // Register a custom parser for 'clearance' to override default
292 bool parserCalled = false;
294 [&]( const std::shared_ptr<DRC_RULE>& aRule ) -> std::shared_ptr<DRC_RE_BASE_CONSTRAINT_DATA>
295 {
296 if( aRule->FindConstraint( CLEARANCE_CONSTRAINT ) )
297 {
298 parserCalled = true;
299 auto data = std::make_shared<DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA>( 0, 0, aRule->m_Name );
300 data->SetConstraintCode( "custom_clearance" );
301 return data;
302 }
303 return nullptr;
304 } );
305
306 wxString ruleText = "(version 1) (rule \"Test Rule\" (constraint clearance (min 1.0mm)) (condition \"A.Type == 'Pad'\"))";
307 auto parsedRules = DRC_RULE_EDITOR_UTILS::ParseRules( ruleText );
308
309 BOOST_CHECK( parserCalled );
310 BOOST_REQUIRE_EQUAL( parsedRules.size(), 1 );
311 BOOST_CHECK_EQUAL( parsedRules[0]->GetConstraintCode(), "custom_clearance" );
312}
313
314BOOST_AUTO_TEST_CASE( ValidateViaStyleValid )
315{
316 DRC_RE_VIA_STYLE_CONSTRAINT_DATA data( 0, 0, "ValidRule", 0.5, 0.8, 0.2, 0.4 );
317
319
320 BOOST_CHECK( result.isValid );
321 BOOST_CHECK( result.errors.empty() );
322}
323
324BOOST_AUTO_TEST_CASE( ValidateViaStyleInvalidMinGreaterThanMax )
325{
326 // min > max for via diameter
327 DRC_RE_VIA_STYLE_CONSTRAINT_DATA data( 0, 0, "InvalidRule", 0.9, 0.5, 0.2, 0.4 );
328
330
331 BOOST_CHECK( !result.isValid );
332 BOOST_CHECK( !result.errors.empty() );
333
334 // Should have error about min > max
335 bool foundMinMaxError = false;
336 for( const auto& error : result.errors )
337 {
338 if( error.find( "Minimum Via Diameter cannot be greater than Maximum Via Diameter" ) != std::string::npos )
339 foundMinMaxError = true;
340 }
341 BOOST_CHECK( foundMinMaxError );
342}
343
344BOOST_AUTO_TEST_CASE( ValidateViaStyleInvalidNegativeValues )
345{
346 // Negative values
347 DRC_RE_VIA_STYLE_CONSTRAINT_DATA data( 0, 0, "NegativeRule", -0.5, 0.8, 0.2, 0.4 );
348
350
351 BOOST_CHECK( !result.isValid );
352 BOOST_CHECK( !result.errors.empty() );
353
354 // Should have error about negative value
355 bool foundNegativeError = false;
356 for( const auto& error : result.errors )
357 {
358 if( error.find( "must be greater than 0" ) != std::string::npos )
359 foundNegativeError = true;
360 }
361 BOOST_CHECK( foundNegativeError );
362}
363
364BOOST_AUTO_TEST_CASE( FactoryOverwrite )
365{
366 // Register a parser
368 []( const std::shared_ptr<DRC_RULE>& aRule ) -> std::shared_ptr<DRC_RE_BASE_CONSTRAINT_DATA> {
369 if( aRule->m_Name == "Test" )
370 return std::make_shared<DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA>( 0, 0, aRule->m_Name + "_1" );
371 return nullptr;
372 } );
373
374 // Overwrite it (prepend)
376 []( const std::shared_ptr<DRC_RULE>& aRule ) -> std::shared_ptr<DRC_RE_BASE_CONSTRAINT_DATA> {
377 if( aRule->m_Name == "Test" )
378 return std::make_shared<DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA>( 0, 0, aRule->m_Name + "_2" );
379 return nullptr;
380 } );
381
382 wxString ruleText = "(version 1) (rule \"Test\" (constraint clearance (min 1.0mm)))";
383 auto parsedRules = DRC_RULE_EDITOR_UTILS::ParseRules( ruleText );
384
385 BOOST_REQUIRE_EQUAL( parsedRules.size(), 1 );
386 BOOST_CHECK_EQUAL( parsedRules[0]->GetRuleName(), "Test_2" );
387}
388
389BOOST_AUTO_TEST_CASE( ValidateAbsLengthTwoValid )
390{
391 // Valid: min < opt < max, all positive
392 DRC_RE_ABSOLUTE_LENGTH_TWO_CONSTRAINT_DATA data( 0, 0, 3.0, 2.0, "ValidLengthRule" );
393
395
396 BOOST_CHECK( result.isValid );
397 BOOST_CHECK( result.errors.empty() );
398}
399
400BOOST_AUTO_TEST_CASE( ValidateAbsLengthTwoInvalid )
401{
402 // Invalid: tolerance too large, resulting minimum length is not positive
403 DRC_RE_ABSOLUTE_LENGTH_TWO_CONSTRAINT_DATA data1( 0, 0, 2.0, 5.0, "InvalidToleranceRule" );
404
405 VALIDATION_RESULT result1 = data1.Validate();
406
407 BOOST_CHECK( !result1.isValid );
408 BOOST_CHECK( !result1.errors.empty() );
409
410 bool foundToleranceError = false;
411
412 for( const auto& error : result1.errors )
413 {
414 if( error.find( "Tolerance is too large" ) != std::string::npos )
415 foundToleranceError = true;
416 }
417
418 BOOST_CHECK( foundToleranceError );
419
420 // Invalid: negative tolerance
421 DRC_RE_ABSOLUTE_LENGTH_TWO_CONSTRAINT_DATA data2( 0, 0, 3.0, -1.0, "NegativeToleranceRule" );
422
423 VALIDATION_RESULT result2 = data2.Validate();
424
425 BOOST_CHECK( !result2.isValid );
426
427 bool foundNegativeError = false;
428
429 for( const auto& error : result2.errors )
430 {
431 if( error.find( "Tolerance must be greater than or equal to 0" ) != std::string::npos )
432 foundNegativeError = true;
433 }
434
435 BOOST_CHECK( foundNegativeError );
436}
437
438BOOST_AUTO_TEST_CASE( ValidateDiffPairValid )
439{
440 // Valid: all positive, min <= preferred <= max for width and gap
441 // Constructor: id, parentId, ruleName, optWidth, widthTolerance, optGap, gapTolerance, maxUncoupledLength, maxSkew
442 DRC_RE_ROUTING_DIFF_PAIR_CONSTRAINT_DATA data( 0, 0, "ValidDiffPairRule", 0.3, 0.1, 0.15, 0.05, 10.0 );
443
445
446 BOOST_CHECK( result.isValid );
447 BOOST_CHECK( result.errors.empty() );
448}
449
450BOOST_AUTO_TEST_CASE( ValidateDiffPairInvalid )
451{
452 // Invalid: min width > max width
453 DRC_RE_ROUTING_DIFF_PAIR_CONSTRAINT_DATA data1( 0, 0, "InvalidWidthRule", 0.3, 0.5, 0.15, 0.05, 10.0 );
454
455 VALIDATION_RESULT result1 = data1.Validate();
456
457 BOOST_CHECK( !result1.isValid );
458 BOOST_CHECK( !result1.errors.empty() );
459
460 bool foundWidthError = false;
461 for( const auto& error : result1.errors )
462 {
463 if( error.find( "Width Tolerance must be less than Optimum Width" ) != std::string::npos )
464 foundWidthError = true;
465 }
466 BOOST_CHECK( foundWidthError );
467
468 // Invalid: negative gap
469 DRC_RE_ROUTING_DIFF_PAIR_CONSTRAINT_DATA data2( 0, 0, "NegativeGapRule", 0.3, 0.1, 0.15, -0.1, 10.0 );
470
471 VALIDATION_RESULT result2 = data2.Validate();
472
473 BOOST_CHECK( !result2.isValid );
474
475 bool foundNegativeError = false;
476 for( const auto& error : result2.errors )
477 {
478 if( error.find( "must be greater than or equal to 0" ) != std::string::npos )
479 foundNegativeError = true;
480 }
481 BOOST_CHECK( foundNegativeError );
482}
483
484BOOST_AUTO_TEST_CASE( ValidatePermittedLayersValid )
485{
486 // Valid: at least one layer is selected (top layer enabled)
487 DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA data1( 0, 0, "ValidTopLayerRule", true, false );
488
489 VALIDATION_RESULT result1 = data1.Validate();
490
491 BOOST_CHECK( result1.isValid );
492 BOOST_CHECK( result1.errors.empty() );
493
494 // Valid: at least one layer is selected (bottom layer enabled)
495 DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA data2( 0, 0, "ValidBottomLayerRule", false, true );
496
497 VALIDATION_RESULT result2 = data2.Validate();
498
499 BOOST_CHECK( result2.isValid );
500 BOOST_CHECK( result2.errors.empty() );
501
502 // Valid: both layers enabled
503 DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA data3( 0, 0, "ValidBothLayersRule", true, true );
504
505 VALIDATION_RESULT result3 = data3.Validate();
506
507 BOOST_CHECK( result3.isValid );
508 BOOST_CHECK( result3.errors.empty() );
509}
510
511BOOST_AUTO_TEST_CASE( ValidatePermittedLayersInvalid )
512{
513 // Invalid: no layers selected
514 DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA data( 0, 0, "NoLayersRule", false, false );
515
517
518 BOOST_CHECK( !result.isValid );
519 BOOST_CHECK( !result.errors.empty() );
520
521 bool foundLayerError = false;
522 for( const auto& error : result.errors )
523 {
524 if( error.find( "At least one layer must be selected" ) != std::string::npos )
525 foundLayerError = true;
526 }
527 BOOST_CHECK( foundLayerError );
528}
529
530BOOST_AUTO_TEST_CASE( ValidateNumericInputValid )
531{
532 DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA data( 0, 0, 0.5, "ValidRule" );
533
535
536 BOOST_CHECK( result.isValid );
537 BOOST_CHECK( result.errors.empty() );
538}
539
540BOOST_AUTO_TEST_CASE( ValidateNumericInputInvalidNegative )
541{
542 DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA data( 0, 0, -0.5, "InvalidRule" );
543
545
546 BOOST_CHECK( !result.isValid );
547 BOOST_CHECK( !result.errors.empty() );
548
549 // Should have error about value not being greater than 0
550 bool foundError = false;
551 for( const auto& error : result.errors )
552 {
553 if( error.find( "must be greater than 0" ) != std::string::npos )
554 foundError = true;
555 }
556 BOOST_CHECK( foundError );
557}
558
559BOOST_AUTO_TEST_CASE( ValidateRoutingWidthValid )
560{
561 DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA data( 0, 0, "ValidRule", 0.3, 0.1 );
562
564
565 BOOST_CHECK( result.isValid );
566 BOOST_CHECK( result.errors.empty() );
567}
568
569BOOST_AUTO_TEST_CASE( ValidateRoutingWidthInvalidToleranceTooLarge )
570{
571 // tolerance >= opt width
572 DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA data( 0, 0, "InvalidRule", 0.3, 0.5 );
573
575
576 BOOST_CHECK( !result.isValid );
577 BOOST_CHECK( !result.errors.empty() );
578
579 bool foundError = false;
580 for( const auto& error : result.errors )
581 {
582 if( error.find( "Width Tolerance must be less than Optimum Width" ) != std::string::npos )
583 foundError = true;
584 }
585 BOOST_CHECK( foundError );
586}
587
588BOOST_AUTO_TEST_CASE( ValidateAllowedOrientationValid )
589{
590 // Valid: at least one orientation is selected (0 degrees)
591 DRC_RE_ALLOWED_ORIENTATION_CONSTRAINT_DATA data1( 0, 0, true, false, false, false, false, "ValidZeroDegRule" );
592
593 VALIDATION_RESULT result1 = data1.Validate();
594
595 BOOST_CHECK( result1.isValid );
596 BOOST_CHECK( result1.errors.empty() );
597
598 // Valid: 90 degrees selected
599 DRC_RE_ALLOWED_ORIENTATION_CONSTRAINT_DATA data2( 0, 0, false, true, false, false, false, "ValidNinetyDegRule" );
600
601 VALIDATION_RESULT result2 = data2.Validate();
602
603 BOOST_CHECK( result2.isValid );
604 BOOST_CHECK( result2.errors.empty() );
605
606 // Valid: all degrees selected
607 DRC_RE_ALLOWED_ORIENTATION_CONSTRAINT_DATA data3( 0, 0, false, false, false, false, true, "ValidAllDegreesRule" );
608
609 VALIDATION_RESULT result3 = data3.Validate();
610
611 BOOST_CHECK( result3.isValid );
612 BOOST_CHECK( result3.errors.empty() );
613
614 // Valid: multiple orientations selected
615 DRC_RE_ALLOWED_ORIENTATION_CONSTRAINT_DATA data4( 0, 0, true, true, false, false, false, "ValidMultipleRule" );
616
617 VALIDATION_RESULT result4 = data4.Validate();
618
619 BOOST_CHECK( result4.isValid );
620 BOOST_CHECK( result4.errors.empty() );
621}
622
623BOOST_AUTO_TEST_CASE( ValidateAllowedOrientationInvalid )
624{
625 // Invalid: no orientation selected
626 DRC_RE_ALLOWED_ORIENTATION_CONSTRAINT_DATA data( 0, 0, false, false, false, false, false, "NoOrientationRule" );
627
629
630 BOOST_CHECK( !result.isValid );
631 BOOST_CHECK( !result.errors.empty() );
632
633 bool foundOrientationError = false;
634 for( const auto& error : result.errors )
635 {
636 if( error.find( "At least one orientation must be selected" ) != std::string::npos )
637 foundOrientationError = true;
638 }
639 BOOST_CHECK( foundOrientationError );
640}
641
642BOOST_AUTO_TEST_CASE( ValidateBoolInputValid )
643{
644 // Test with true value
645 DRC_RE_BOOL_INPUT_CONSTRAINT_DATA dataTrue( 0, 0, true, "BoolRuleTrue" );
646
647 VALIDATION_RESULT resultTrue = dataTrue.Validate();
648
649 BOOST_CHECK( resultTrue.isValid );
650 BOOST_CHECK( resultTrue.errors.empty() );
651
652 // Test with false value
653 DRC_RE_BOOL_INPUT_CONSTRAINT_DATA dataFalse( 0, 0, false, "BoolRuleFalse" );
654
655 VALIDATION_RESULT resultFalse = dataFalse.Validate();
656
657 BOOST_CHECK( resultFalse.isValid );
658 BOOST_CHECK( resultFalse.errors.empty() );
659}
660
661BOOST_AUTO_TEST_CASE( ValidateMinTxtHtThValid )
662{
663 // Valid: both text height and thickness are positive
664 DRC_RE_MINIMUM_TEXT_HEIGHT_THICKNESS_CONSTRAINT_DATA data( 0, 0, "ValidTextRule", 1.0, 0.15 );
665
667
668 BOOST_CHECK( result.isValid );
669 BOOST_CHECK( result.errors.empty() );
670}
671
672BOOST_AUTO_TEST_CASE( ValidateMinTxtHtThInvalid )
673{
674 // Invalid: negative text height
675 DRC_RE_MINIMUM_TEXT_HEIGHT_THICKNESS_CONSTRAINT_DATA data1( 0, 0, "NegativeHeightRule", -1.0, 0.15 );
676
677 VALIDATION_RESULT result1 = data1.Validate();
678
679 BOOST_CHECK( !result1.isValid );
680 BOOST_CHECK( !result1.errors.empty() );
681
682 bool foundHeightError = false;
683 for( const auto& error : result1.errors )
684 {
685 if( error.find( "Minimum Text Height must be greater than 0" ) != std::string::npos )
686 foundHeightError = true;
687 }
688 BOOST_CHECK( foundHeightError );
689
690 // Invalid: negative text thickness
691 DRC_RE_MINIMUM_TEXT_HEIGHT_THICKNESS_CONSTRAINT_DATA data2( 0, 0, "NegativeThicknessRule", 1.0, -0.15 );
692
693 VALIDATION_RESULT result2 = data2.Validate();
694
695 BOOST_CHECK( !result2.isValid );
696
697 bool foundThicknessError = false;
698 for( const auto& error : result2.errors )
699 {
700 if( error.find( "Minimum Text Thickness must be greater than 0" ) != std::string::npos )
701 foundThicknessError = true;
702 }
703 BOOST_CHECK( foundThicknessError );
704
705 // Invalid: both zero (default values)
707
708 VALIDATION_RESULT result3 = data3.Validate();
709
710 BOOST_CHECK( !result3.isValid );
711 BOOST_CHECK_EQUAL( result3.errors.size(), 2 );
712}
713
714BOOST_AUTO_TEST_CASE( ValidateCustomRuleValid )
715{
716 DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA data( 0, 0, "ValidCustomRule" );
717 data.SetRuleText( "(constraint clearance (min 0.2mm))" );
718
720
721 BOOST_CHECK( result.isValid );
722 BOOST_CHECK( result.errors.empty() );
723}
724
725BOOST_AUTO_TEST_CASE( ValidateCustomRuleInvalid )
726{
727 DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA data( 0, 0, "InvalidCustomRule" );
728 data.SetRuleText( "" );
729
731
732 BOOST_CHECK( !result.isValid );
733 BOOST_CHECK( !result.errors.empty() );
734
735 // Should have error about empty rule text
736 bool foundEmptyError = false;
737 for( const auto& error : result.errors )
738 {
739 if( error.find( "Rule text cannot be empty" ) != std::string::npos )
740 foundEmptyError = true;
741 }
742 BOOST_CHECK( foundEmptyError );
743}
744
745
746// ============================================================================
747// Panel Matcher Tests (Phase 5.1)
748// ============================================================================
749
750BOOST_AUTO_TEST_CASE( PanelMatcherExactMatchViaStyle )
751{
752 // Test: Rule with via_diameter + hole_size → VIA_STYLE panel
753 DRC_RULE rule( "ViaStyleRule" );
754
756 viaDia.Value().SetMin( 500000 );
757 viaDia.Value().SetOpt( 600000 );
758 viaDia.Value().SetMax( 800000 );
759 rule.AddConstraint( viaDia );
760
762 holeSize.Value().SetMin( 200000 );
763 holeSize.Value().SetOpt( 300000 );
764 holeSize.Value().SetMax( 400000 );
765 rule.AddConstraint( holeSize );
766
767 DRC_PANEL_MATCHER matcher;
768 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
769
770 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
771 BOOST_CHECK_EQUAL( matches[0].panelType, VIA_STYLE );
772 BOOST_CHECK_EQUAL( matches[0].claimedConstraints.size(), 2 );
773 BOOST_CHECK( matches[0].claimedConstraints.count( VIA_DIAMETER_CONSTRAINT ) > 0 );
774 BOOST_CHECK( matches[0].claimedConstraints.count( HOLE_SIZE_CONSTRAINT ) > 0 );
775}
776
777BOOST_AUTO_TEST_CASE( PanelMatcherPartialMatchViaDiameter )
778{
779 // Test: Rule with only via_diameter → MINIMUM_VIA_DIAMETER panel
780 DRC_RULE rule( "ViaDiameterOnlyRule" );
781
783 viaDia.Value().SetMin( 500000 );
784 rule.AddConstraint( viaDia );
785
786 DRC_PANEL_MATCHER matcher;
787 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
788
789 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
790 BOOST_CHECK_EQUAL( matches[0].panelType, MINIMUM_VIA_DIAMETER );
791 BOOST_CHECK_EQUAL( matches[0].claimedConstraints.size(), 1 );
792 BOOST_CHECK( matches[0].claimedConstraints.count( VIA_DIAMETER_CONSTRAINT ) > 0 );
793}
794
795BOOST_AUTO_TEST_CASE( PanelMatcherSplitRule )
796{
797 // Test: Rule with via_diameter + hole_size + clearance → 2 panels
798 DRC_RULE rule( "SplitRule" );
799
801 viaDia.Value().SetMin( 500000 );
802 rule.AddConstraint( viaDia );
803
805 holeSize.Value().SetMin( 200000 );
806 rule.AddConstraint( holeSize );
807
809 clearance.Value().SetMin( 150000 );
810 rule.AddConstraint( clearance );
811
812 DRC_PANEL_MATCHER matcher;
813 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
814
815 BOOST_REQUIRE_EQUAL( matches.size(), 2 );
816
817 // VIA_STYLE should claim via_diameter + hole_size
818 BOOST_CHECK_EQUAL( matches[0].panelType, VIA_STYLE );
819 BOOST_CHECK_EQUAL( matches[0].claimedConstraints.size(), 2 );
820
821 // MINIMUM_CLEARANCE should claim clearance
822 BOOST_CHECK_EQUAL( matches[1].panelType, MINIMUM_CLEARANCE );
823 BOOST_CHECK_EQUAL( matches[1].claimedConstraints.size(), 1 );
824 BOOST_CHECK( matches[1].claimedConstraints.count( CLEARANCE_CONSTRAINT ) > 0 );
825}
826
827BOOST_AUTO_TEST_CASE( PanelMatcherPriorityDiffPairOverRoutingWidth )
828{
829 // Test: Rule with track_width + diff_pair_gap → ROUTING_DIFF_PAIR (not ROUTING_WIDTH)
830 DRC_RULE rule( "DiffPairRule" );
831
833 trackWidth.Value().SetMin( 200000 );
834 trackWidth.Value().SetOpt( 250000 );
835 trackWidth.Value().SetMax( 300000 );
836 rule.AddConstraint( trackWidth );
837
839 diffGap.Value().SetMin( 100000 );
840 diffGap.Value().SetOpt( 150000 );
841 diffGap.Value().SetMax( 200000 );
842 rule.AddConstraint( diffGap );
843
844 DRC_PANEL_MATCHER matcher;
845 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
846
847 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
848 BOOST_CHECK_EQUAL( matches[0].panelType, ROUTING_DIFF_PAIR );
849 BOOST_CHECK( matches[0].claimedConstraints.count( TRACK_WIDTH_CONSTRAINT ) > 0 );
850 BOOST_CHECK( matches[0].claimedConstraints.count( DIFF_PAIR_GAP_CONSTRAINT ) > 0 );
851}
852
853BOOST_AUTO_TEST_CASE( PanelMatcherDiffPairWithOptionalUncoupled )
854{
855 // Test: Rule with track_width + diff_pair_gap + uncoupled → ROUTING_DIFF_PAIR claims all three
856 DRC_RULE rule( "DiffPairWithUncoupledRule" );
857
859 trackWidth.Value().SetMin( 200000 );
860 rule.AddConstraint( trackWidth );
861
863 diffGap.Value().SetMin( 100000 );
864 rule.AddConstraint( diffGap );
865
867 uncoupled.Value().SetMax( 5000000 );
868 rule.AddConstraint( uncoupled );
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_DIFF_PAIR );
875 BOOST_CHECK_EQUAL( matches[0].claimedConstraints.size(), 3 );
876 BOOST_CHECK( matches[0].claimedConstraints.count( TRACK_WIDTH_CONSTRAINT ) > 0 );
877 BOOST_CHECK( matches[0].claimedConstraints.count( DIFF_PAIR_GAP_CONSTRAINT ) > 0 );
878 BOOST_CHECK( matches[0].claimedConstraints.count( MAX_UNCOUPLED_CONSTRAINT ) > 0 );
879}
880
881BOOST_AUTO_TEST_CASE( PanelMatcherTrackWidthOnly )
882{
883 // Test: Rule with only track_width → ROUTING_WIDTH (not ROUTING_DIFF_PAIR)
884 DRC_RULE rule( "TrackWidthOnlyRule" );
885
887 trackWidth.Value().SetMin( 200000 );
888 trackWidth.Value().SetOpt( 250000 );
889 trackWidth.Value().SetMax( 300000 );
890 rule.AddConstraint( trackWidth );
891
892 DRC_PANEL_MATCHER matcher;
893 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
894
895 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
896 BOOST_CHECK_EQUAL( matches[0].panelType, ROUTING_WIDTH );
897 BOOST_CHECK( matches[0].claimedConstraints.count( TRACK_WIDTH_CONSTRAINT ) > 0 );
898}
899
900BOOST_AUTO_TEST_CASE( PanelMatcherTextHeightAndThickness )
901{
902 // Test: Rule with text_height + text_thickness → MINIMUM_TEXT_HEIGHT_AND_THICKNESS
903 DRC_RULE rule( "TextRule" );
904
906 textHeight.Value().SetMin( 1000000 );
907 rule.AddConstraint( textHeight );
908
910 textThickness.Value().SetMin( 150000 );
911 rule.AddConstraint( textThickness );
912
913 DRC_PANEL_MATCHER matcher;
914 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
915
916 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
918 BOOST_CHECK_EQUAL( matches[0].claimedConstraints.size(), 2 );
919}
920
921BOOST_AUTO_TEST_CASE( PanelMatcherLengthConstraint )
922{
923 // Test: Rule with length constraint matches ABSOLUTE_LENGTH panel
924 DRC_RULE rule( "LengthRule" );
925
927 length.Value().SetMin( 10000000 );
928 length.Value().SetOpt( 30000000 );
929 length.Value().SetMax( 50000000 );
930 rule.AddConstraint( length );
931
932 DRC_PANEL_MATCHER matcher;
933 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
934
935 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
936 BOOST_CHECK_EQUAL( matches[0].panelType, ABSOLUTE_LENGTH );
937 BOOST_CHECK( matches[0].claimedConstraints.count( LENGTH_CONSTRAINT ) > 0 );
938}
939
940BOOST_AUTO_TEST_CASE( PanelMatcherLengthAndSkewConstraint )
941{
942 // Rule with length + skew should match MATCHED_LENGTH_DIFF_PAIR, not ABSOLUTE_LENGTH
943 DRC_RULE rule( "MatchedLengthRule" );
944
946 length.Value().SetMin( 10000000 );
947 length.Value().SetOpt( 30000000 );
948 length.Value().SetMax( 50000000 );
949 rule.AddConstraint( length );
950
952 skew.Value().SetMax( 1000000 );
953 rule.AddConstraint( skew );
954
955 DRC_PANEL_MATCHER matcher;
956 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
957
958 BOOST_REQUIRE_EQUAL( matches.size(), 1 );
959 BOOST_CHECK_EQUAL( matches[0].panelType, MATCHED_LENGTH_DIFF_PAIR );
960 BOOST_CHECK( matches[0].claimedConstraints.count( LENGTH_CONSTRAINT ) > 0 );
961 BOOST_CHECK( matches[0].claimedConstraints.count( SKEW_CONSTRAINT ) > 0 );
962}
963
964BOOST_AUTO_TEST_CASE( PanelMatcherEmptyRule )
965{
966 // Test: Rule with no constraints → no matches
967 DRC_RULE rule( "EmptyRule" );
968
969 DRC_PANEL_MATCHER matcher;
970 std::vector<DRC_PANEL_MATCH> matches = matcher.MatchRule( rule );
971
972 BOOST_CHECK_EQUAL( matches.size(), 0 );
973}
974
975BOOST_AUTO_TEST_CASE( PanelMatcherCanPanelLoad )
976{
977 DRC_PANEL_MATCHER matcher;
978
979 // VIA_STYLE can load via_diameter + hole_size
980 std::set<DRC_CONSTRAINT_T> viaStyleConstraints = { VIA_DIAMETER_CONSTRAINT, HOLE_SIZE_CONSTRAINT };
981 BOOST_CHECK( matcher.CanPanelLoad( VIA_STYLE, viaStyleConstraints ) );
982
983 // VIA_STYLE cannot load clearance
984 std::set<DRC_CONSTRAINT_T> clearanceConstraint = { CLEARANCE_CONSTRAINT };
985 BOOST_CHECK( !matcher.CanPanelLoad( VIA_STYLE, clearanceConstraint ) );
986
987 // CUSTOM_RULE can load anything
988 BOOST_CHECK( matcher.CanPanelLoad( CUSTOM_RULE, viaStyleConstraints ) );
989 BOOST_CHECK( matcher.CanPanelLoad( CUSTOM_RULE, clearanceConstraint ) );
990}
991
1004
1005
1006// ============================================================================
1007// Rule Loader Tests (Phase 5.1)
1008// ============================================================================
1009
1010BOOST_AUTO_TEST_CASE( RuleLoaderViaStyleFromText )
1011{
1012 // Test: Load a via style rule from text and verify values
1013 wxString ruleText =
1014 "(version 1)\n"
1015 "(rule \"Via Test\"\n"
1016 " (constraint via_diameter (min 0.5mm) (opt 0.6mm) (max 0.8mm))\n"
1017 " (constraint hole_size (min 0.2mm) (opt 0.3mm) (max 0.4mm)))";
1018
1019 DRC_RULE_LOADER loader;
1020 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1021
1022 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1023 BOOST_CHECK_EQUAL( entries[0].panelType, VIA_STYLE );
1024 BOOST_CHECK_EQUAL( entries[0].ruleName, "Via Test" );
1025
1026 auto viaData = std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( entries[0].constraintData );
1027 BOOST_REQUIRE( viaData );
1028
1029 BOOST_CHECK_CLOSE( viaData->GetMinViaDiameter(), 0.5, 0.0001 );
1030 BOOST_CHECK_CLOSE( viaData->GetMaxViaDiameter(), 0.8, 0.0001 );
1031 BOOST_CHECK_CLOSE( viaData->GetMinViaHoleSize(), 0.2, 0.0001 );
1032 BOOST_CHECK_CLOSE( viaData->GetMaxViaHoleSize(), 0.4, 0.0001 );
1033}
1034
1035BOOST_AUTO_TEST_CASE( RuleLoaderRoutingWidthFromText )
1036{
1037 // Test: Load a routing width rule from text
1038 wxString ruleText =
1039 "(version 1)\n"
1040 "(rule \"Track Test\"\n"
1041 " (constraint track_width (min 0.2mm) (opt 0.25mm) (max 0.3mm)))";
1042
1043 DRC_RULE_LOADER loader;
1044 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1045
1046 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1047 BOOST_CHECK_EQUAL( entries[0].panelType, ROUTING_WIDTH );
1048 BOOST_CHECK_EQUAL( entries[0].ruleName, "Track Test" );
1049
1050 auto trackData = std::dynamic_pointer_cast<DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA>( entries[0].constraintData );
1051 BOOST_REQUIRE( trackData );
1052
1053 BOOST_CHECK_CLOSE( trackData->GetOptWidth(), 0.25, 0.0001 );
1054 BOOST_CHECK_CLOSE( trackData->GetWidthTolerance(), 0.05, 0.0001 );
1055}
1056
1057BOOST_AUTO_TEST_CASE( RuleLoaderDiffPairFromText )
1058{
1059 // Test: Load a diff pair rule from text
1060 wxString ruleText =
1061 "(version 1)\n"
1062 "(rule \"Diff Pair Test\"\n"
1063 " (constraint track_width (min 0.2mm) (opt 0.25mm) (max 0.3mm))\n"
1064 " (constraint diff_pair_gap (min 0.1mm) (opt 0.15mm) (max 0.2mm))\n"
1065 " (constraint diff_pair_uncoupled (max 5mm)))";
1066
1067 DRC_RULE_LOADER loader;
1068 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1069
1070 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1071 BOOST_CHECK_EQUAL( entries[0].panelType, ROUTING_DIFF_PAIR );
1072
1073 auto dpData = std::dynamic_pointer_cast<DRC_RE_ROUTING_DIFF_PAIR_CONSTRAINT_DATA>( entries[0].constraintData );
1074 BOOST_REQUIRE( dpData );
1075
1076 BOOST_CHECK_CLOSE( dpData->GetOptWidth(), 0.25, 0.0001 );
1077 BOOST_CHECK_CLOSE( dpData->GetWidthTolerance(), 0.05, 0.0001 );
1078 BOOST_CHECK_CLOSE( dpData->GetOptGap(), 0.15, 0.0001 );
1079 BOOST_CHECK_CLOSE( dpData->GetGapTolerance(), 0.05, 0.0001 );
1080 BOOST_CHECK_CLOSE( dpData->GetMaxUncoupledLength(), 5.0, 0.0001 );
1081}
1082
1083BOOST_AUTO_TEST_CASE( RuleLoaderSplitRuleFromText )
1084{
1085 // Test: Load a rule that splits into multiple panels
1086 wxString ruleText =
1087 "(version 1)\n"
1088 "(rule \"Split Test\"\n"
1089 " (constraint via_diameter (min 0.5mm))\n"
1090 " (constraint hole_size (min 0.2mm))\n"
1091 " (constraint clearance (min 0.15mm)))";
1092
1093 DRC_RULE_LOADER loader;
1094 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1095
1096 BOOST_REQUIRE_EQUAL( entries.size(), 2 );
1097
1098 // First entry should be VIA_STYLE
1099 BOOST_CHECK_EQUAL( entries[0].panelType, VIA_STYLE );
1100 BOOST_CHECK_EQUAL( entries[0].ruleName, "Split Test" );
1101
1102 // Second entry should be MINIMUM_CLEARANCE
1103 BOOST_CHECK_EQUAL( entries[1].panelType, MINIMUM_CLEARANCE );
1104 BOOST_CHECK_EQUAL( entries[1].ruleName, "Split Test" );
1105
1106 auto numericData = std::dynamic_pointer_cast<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>( entries[1].constraintData );
1107 BOOST_REQUIRE( numericData );
1108 BOOST_CHECK_CLOSE( numericData->GetNumericInputValue(), 0.15, 0.0001 );
1109}
1110
1111BOOST_AUTO_TEST_CASE( RuleLoaderVmeWrenClearanceUnderFpga )
1112{
1113 // Test: Load the clearance_under_fpga rule from vme-wren demo which should split
1114 // This rule has: clearance, hole_size, via_diameter
1115 // Should split into: VIA_STYLE (hole_size + via_diameter) + MINIMUM_CLEARANCE (clearance)
1116 wxString ruleText =
1117 "(version 1)\n"
1118 "(rule \"clearance_under_fpga\"\n"
1119 " (constraint clearance (min 0.1mm))\n"
1120 " (constraint hole_size (min 0.2mm))\n"
1121 " (constraint via_diameter (min 0.4mm))\n"
1122 " (condition \"A.intersectsArea('underFPGA') || A.intersectsArea('underDDR')\"))";
1123
1124 DRC_RULE_LOADER loader;
1125 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1126
1127 // Should produce 2 entries from the split
1128 BOOST_REQUIRE_EQUAL( entries.size(), 2 );
1129
1130 // First entry should be VIA_STYLE (claims via_diameter + hole_size at priority 90)
1131 BOOST_CHECK_EQUAL( entries[0].panelType, VIA_STYLE );
1132 BOOST_CHECK_EQUAL( entries[0].ruleName, "clearance_under_fpga" );
1133 BOOST_CHECK_EQUAL( entries[0].condition, "A.intersectsArea('underFPGA') || A.intersectsArea('underDDR')" );
1134
1135 // Second entry should be MINIMUM_CLEARANCE (claims clearance at priority 30)
1136 BOOST_CHECK_EQUAL( entries[1].panelType, MINIMUM_CLEARANCE );
1137 BOOST_CHECK_EQUAL( entries[1].ruleName, "clearance_under_fpga" );
1138 BOOST_CHECK_EQUAL( entries[1].condition, "A.intersectsArea('underFPGA') || A.intersectsArea('underDDR')" );
1139
1140 // Verify VIA_STYLE has correct values
1141 auto viaData = std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( entries[0].constraintData );
1142 BOOST_REQUIRE( viaData );
1143 BOOST_CHECK_CLOSE( viaData->GetMinViaDiameter(), 0.4, 0.0001 );
1144 BOOST_CHECK_CLOSE( viaData->GetMinViaHoleSize(), 0.2, 0.0001 );
1145
1146 // Verify MINIMUM_CLEARANCE has correct value
1147 auto clearanceData = std::dynamic_pointer_cast<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>( entries[1].constraintData );
1148 BOOST_REQUIRE( clearanceData );
1149 BOOST_CHECK_CLOSE( clearanceData->GetNumericInputValue(), 0.1, 0.0001 );
1150}
1151
1152BOOST_AUTO_TEST_CASE( RuleLoaderTextHeightThicknessFromText )
1153{
1154 // Test: Load text height and thickness rule
1155 wxString ruleText =
1156 "(version 1)\n"
1157 "(rule \"Text Test\"\n"
1158 " (constraint text_height (min 1mm))\n"
1159 " (constraint text_thickness (min 0.15mm)))";
1160
1161 DRC_RULE_LOADER loader;
1162 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1163
1164 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1166
1167 auto textData = std::dynamic_pointer_cast<DRC_RE_MINIMUM_TEXT_HEIGHT_THICKNESS_CONSTRAINT_DATA>( entries[0].constraintData );
1168 BOOST_REQUIRE( textData );
1169
1170 BOOST_CHECK_CLOSE( textData->GetMinTextHeight(), 1.0, 0.0001 );
1171 BOOST_CHECK_CLOSE( textData->GetMinTextThickness(), 0.15, 0.0001 );
1172}
1173
1174BOOST_AUTO_TEST_CASE( RuleLoaderAbsoluteLengthFromText )
1175{
1176 // Test: Load absolute length rule with min/opt/max
1177 wxString ruleText =
1178 "(version 1)\n"
1179 "(rule \"Length Test\"\n"
1180 " (constraint length (min 10mm) (opt 30mm) (max 50mm)))";
1181
1182 DRC_RULE_LOADER loader;
1183 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1184
1185 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1186 BOOST_CHECK_EQUAL( entries[0].panelType, ABSOLUTE_LENGTH );
1187 BOOST_CHECK_EQUAL( entries[0].ruleName, "Length Test" );
1188
1189 auto lengthData = dynamic_pointer_cast<DRC_RE_ABSOLUTE_LENGTH_TWO_CONSTRAINT_DATA>( entries[0].constraintData );
1190 BOOST_REQUIRE( lengthData );
1191 BOOST_CHECK_CLOSE( lengthData->GetMinimumLength(), 10.0, 0.0001 );
1192 BOOST_CHECK_CLOSE( lengthData->GetOptimumLength(), 30.0, 0.0001 );
1193 BOOST_CHECK_CLOSE( lengthData->GetMaximumLength(), 50.0, 0.0001 );
1194}
1195
1196BOOST_AUTO_TEST_CASE( RuleLoaderMatchedLengthWithSkew )
1197{
1198 // Rule with length + skew should load as MATCHED_LENGTH_DIFF_PAIR and preserve skew
1199 wxString ruleText =
1200 "(version 1)\n"
1201 "(rule \"DP Length Match\"\n"
1202 " (constraint length (min 10mm) (opt 30mm) (max 50mm))\n"
1203 " (constraint skew (max 1mm)))";
1204
1205 DRC_RULE_LOADER loader;
1206 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1207
1208 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1209 BOOST_CHECK_EQUAL( entries[0].panelType, MATCHED_LENGTH_DIFF_PAIR );
1210 BOOST_CHECK_EQUAL( entries[0].ruleName, "DP Length Match" );
1211
1212 auto matchedData =
1213 std::dynamic_pointer_cast<DRC_RE_MATCHED_LENGTH_DIFF_PAIR_CONSTRAINT_DATA>( entries[0].constraintData );
1214 BOOST_REQUIRE( matchedData );
1215
1216 BOOST_CHECK_CLOSE( matchedData->GetMinimumLength(), 10.0, 0.0001 );
1217 BOOST_CHECK_CLOSE( matchedData->GetOptimumLength(), 30.0, 0.0001 );
1218 BOOST_CHECK_CLOSE( matchedData->GetMaximumLength(), 50.0, 0.0001 );
1219 BOOST_CHECK_CLOSE( matchedData->GetMaxSkew(), 1.0, 0.0001 );
1220}
1221
1222BOOST_AUTO_TEST_CASE( RuleLoaderMatchedLengthRoundTrip )
1223{
1224 // Verify length+skew rule round-trips without losing skew
1225 wxString ruleText =
1226 "(version 1)\n"
1227 "(rule \"DP Match RT\"\n"
1228 " (constraint length (min 10mm) (opt 30mm) (max 50mm))\n"
1229 " (constraint skew (max 2.5mm)))";
1230
1231 DRC_RULE_LOADER loader;
1232 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1233
1234 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1235 entries[0].wasEdited = true;
1236
1237 DRC_RULE_SAVER saver;
1238 wxString savedText = saver.GenerateRulesText( entries, nullptr );
1239
1240 BOOST_CHECK( savedText.Contains( "length" ) );
1241 BOOST_CHECK( savedText.Contains( "skew" ) );
1242 BOOST_CHECK( savedText.Contains( "2.5mm" ) );
1243
1244 std::vector<DRC_RE_LOADED_PANEL_ENTRY> reloaded = loader.LoadFromString( savedText );
1245
1246 BOOST_REQUIRE_EQUAL( reloaded.size(), 1 );
1247 BOOST_CHECK_EQUAL( reloaded[0].panelType, MATCHED_LENGTH_DIFF_PAIR );
1248
1249 auto reloadedData =
1250 std::dynamic_pointer_cast<DRC_RE_MATCHED_LENGTH_DIFF_PAIR_CONSTRAINT_DATA>( reloaded[0].constraintData );
1251 BOOST_REQUIRE( reloadedData );
1252
1253 BOOST_CHECK_CLOSE( reloadedData->GetMaxSkew(), 2.5, 0.0001 );
1254 BOOST_CHECK_CLOSE( reloadedData->GetMinimumLength(), 10.0, 0.0001 );
1255 BOOST_CHECK_CLOSE( reloadedData->GetOptimumLength(), 30.0, 0.0001 );
1256 BOOST_CHECK_CLOSE( reloadedData->GetMaximumLength(), 50.0, 0.0001 );
1257}
1258
1259BOOST_AUTO_TEST_CASE( RuleLoaderMatchedLengthWithinDiffPairs )
1260{
1261 // Rule with skew + within_diff_pairs should load and preserve the option
1262 wxString ruleText = "(version 1)\n"
1263 "(rule \"DP Skew Within\"\n"
1264 " (constraint length (min 10mm) (opt 30mm) (max 50mm))\n"
1265 " (constraint skew (max 1mm) (within_diff_pairs)))";
1266
1267 DRC_RULE_LOADER loader;
1268 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1269
1270 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1271 BOOST_CHECK_EQUAL( entries[0].panelType, MATCHED_LENGTH_DIFF_PAIR );
1272
1273 auto matchedData =
1274 std::dynamic_pointer_cast<DRC_RE_MATCHED_LENGTH_DIFF_PAIR_CONSTRAINT_DATA>( entries[0].constraintData );
1275 BOOST_REQUIRE( matchedData );
1276
1277 BOOST_CHECK_CLOSE( matchedData->GetMaxSkew(), 1.0, 0.0001 );
1278 BOOST_CHECK( matchedData->GetWithinDiffPairs() );
1279
1280 // Round-trip: save and reload
1281 entries[0].wasEdited = true;
1282
1283 DRC_RULE_SAVER saver;
1284 wxString savedText = saver.GenerateRulesText( entries, nullptr );
1285
1286 BOOST_CHECK( savedText.Contains( "within_diff_pairs" ) );
1287
1288 std::vector<DRC_RE_LOADED_PANEL_ENTRY> reloaded = loader.LoadFromString( savedText );
1289
1290 BOOST_REQUIRE_EQUAL( reloaded.size(), 1 );
1291
1292 auto reloadedData =
1293 std::dynamic_pointer_cast<DRC_RE_MATCHED_LENGTH_DIFF_PAIR_CONSTRAINT_DATA>( reloaded[0].constraintData );
1294 BOOST_REQUIRE( reloadedData );
1295
1296 BOOST_CHECK_CLOSE( reloadedData->GetMaxSkew(), 1.0, 0.0001 );
1297 BOOST_CHECK( reloadedData->GetWithinDiffPairs() );
1298}
1299
1300BOOST_AUTO_TEST_CASE( RuleLoaderMatchedLengthWithoutWithinDiffPairs )
1301{
1302 // Rule without within_diff_pairs should default to false
1303 wxString ruleText = "(version 1)\n"
1304 "(rule \"DP Skew Bus\"\n"
1305 " (constraint length (min 10mm) (opt 30mm) (max 50mm))\n"
1306 " (constraint skew (max 2mm)))";
1307
1308 DRC_RULE_LOADER loader;
1309 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1310
1311 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1312
1313 auto matchedData =
1314 std::dynamic_pointer_cast<DRC_RE_MATCHED_LENGTH_DIFF_PAIR_CONSTRAINT_DATA>( entries[0].constraintData );
1315 BOOST_REQUIRE( matchedData );
1316
1317 BOOST_CHECK( !matchedData->GetWithinDiffPairs() );
1318
1319 // Round-trip should NOT contain within_diff_pairs
1320 entries[0].wasEdited = true;
1321
1322 DRC_RULE_SAVER saver;
1323 wxString savedText = saver.GenerateRulesText( entries, nullptr );
1324
1325 BOOST_CHECK( !savedText.Contains( "within_diff_pairs" ) );
1326}
1327
1328BOOST_AUTO_TEST_CASE( RuleLoaderWithCondition )
1329{
1330 // Test: Load rule with condition
1331 wxString ruleText =
1332 "(version 1)\n"
1333 "(rule \"Conditional Test\"\n"
1334 " (condition \"A.NetClass == 'Power'\")\n"
1335 " (constraint clearance (min 0.3mm)))";
1336
1337 DRC_RULE_LOADER loader;
1338 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1339
1340 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1341 BOOST_CHECK_EQUAL( entries[0].ruleName, "Conditional Test" );
1342 BOOST_CHECK_EQUAL( entries[0].condition, "A.NetClass == 'Power'" );
1343 BOOST_CHECK_EQUAL( entries[0].constraintData->GetRuleCondition(), "A.NetClass == 'Power'" );
1344}
1345
1346BOOST_AUTO_TEST_CASE( RuleLoaderMultipleRules )
1347{
1348 // Test: Load multiple rules and verify order preservation
1349 wxString ruleText =
1350 "(version 1)\n"
1351 "(rule \"Rule A\"\n"
1352 " (constraint clearance (min 0.2mm)))\n"
1353 "(rule \"Rule B\"\n"
1354 " (constraint track_width (min 0.15mm)))\n"
1355 "(rule \"Rule C\"\n"
1356 " (constraint via_diameter (min 0.5mm))\n"
1357 " (constraint hole_size (min 0.3mm)))";
1358
1359 DRC_RULE_LOADER loader;
1360 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1361
1362 BOOST_REQUIRE_EQUAL( entries.size(), 3 );
1363
1364 BOOST_CHECK_EQUAL( entries[0].ruleName, "Rule A" );
1365 BOOST_CHECK_EQUAL( entries[0].panelType, MINIMUM_CLEARANCE );
1366
1367 BOOST_CHECK_EQUAL( entries[1].ruleName, "Rule B" );
1368 BOOST_CHECK_EQUAL( entries[1].panelType, ROUTING_WIDTH );
1369
1370 BOOST_CHECK_EQUAL( entries[2].ruleName, "Rule C" );
1371 BOOST_CHECK_EQUAL( entries[2].panelType, VIA_STYLE );
1372}
1373
1374BOOST_AUTO_TEST_CASE( RuleLoaderEmptyRule )
1375{
1376 // Test: Rule with no constraints creates custom rule fallback
1377 wxString ruleText =
1378 "(version 1)\n"
1379 "(rule \"Empty Rule\")";
1380
1381 DRC_RULE_LOADER loader;
1382 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1383
1384 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1385 BOOST_CHECK_EQUAL( entries[0].panelType, CUSTOM_RULE );
1386 BOOST_CHECK_EQUAL( entries[0].ruleName, "Empty Rule" );
1387}
1388
1389BOOST_AUTO_TEST_CASE( RuleLoaderInvalidText )
1390{
1391 // Test: Invalid rule text returns empty vector
1392 wxString ruleText = "not valid rule text at all";
1393
1394 DRC_RULE_LOADER loader;
1395 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1396
1397 BOOST_CHECK_EQUAL( entries.size(), 0 );
1398}
1399
1400BOOST_AUTO_TEST_CASE( RuleLoaderNumericConstraints )
1401{
1402 // Test various numeric constraints map to correct panels
1403 wxString ruleText =
1404 "(version 1)\n"
1405 "(rule \"Edge Clearance\"\n"
1406 " (constraint edge_clearance (min 0.5mm)))\n"
1407 "(rule \"Hole Clearance\"\n"
1408 " (constraint hole_clearance (min 0.3mm)))\n"
1409 "(rule \"Courtyard\"\n"
1410 " (constraint courtyard_clearance (min 0.25mm)))";
1411
1412 DRC_RULE_LOADER loader;
1413 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1414
1415 BOOST_REQUIRE_EQUAL( entries.size(), 3 );
1416
1417 BOOST_CHECK_EQUAL( entries[0].panelType, COPPER_TO_EDGE_CLEARANCE );
1418 BOOST_CHECK_EQUAL( entries[1].panelType, COPPER_TO_HOLE_CLEARANCE );
1419 BOOST_CHECK_EQUAL( entries[2].panelType, COURTYARD_CLEARANCE );
1420}
1421
1422
1423// ============================================================================
1424// Rule Saver Tests (Phase 3)
1425// ============================================================================
1426
1427BOOST_AUTO_TEST_CASE( RuleSaverBasicGeneration )
1428{
1429 // Test: Basic rule text generation from panel entry
1432 entry.ruleName = "TestClearance";
1433 entry.wasEdited = true;
1434
1435 auto numericData = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>();
1436 numericData->SetRuleName( "TestClearance" );
1437 numericData->SetConstraintCode( "clearance" );
1438 numericData->SetNumericInputValue( 0.2 );
1439 entry.constraintData = numericData;
1440
1441 DRC_RULE_SAVER saver;
1442 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1443 wxString result = saver.GenerateRulesText( entries, nullptr );
1444
1445 BOOST_CHECK( result.Contains( "(version 2)" ) );
1446 BOOST_CHECK( result.Contains( "TestClearance" ) );
1447 BOOST_CHECK( result.Contains( "clearance" ) );
1448}
1449
1450BOOST_AUTO_TEST_CASE( RuleSaverRoundTripPreservation )
1451{
1452 // Test: Original text preserved when not edited
1455 entry.ruleName = "Preserved Rule";
1456 entry.originalRuleText = "(rule \"Preserved Rule\"\n\t(constraint clearance (min 0.5mm)))";
1457 entry.wasEdited = false;
1458
1459 auto numericData = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>();
1460 numericData->SetRuleName( "Preserved Rule" );
1461 numericData->SetConstraintCode( "clearance" );
1462 numericData->SetNumericInputValue( 0.5 );
1463 entry.constraintData = numericData;
1464
1465 DRC_RULE_SAVER saver;
1466 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1467 wxString result = saver.GenerateRulesText( entries, nullptr );
1468
1469 BOOST_CHECK( result.Contains( entry.originalRuleText ) );
1470}
1471
1472BOOST_AUTO_TEST_CASE( RuleSaverEditedRuleRegenerated )
1473{
1474 // Test: Edited rules regenerate from panel data
1477 entry.ruleName = "EditedRule";
1478 entry.originalRuleText = "(rule \"EditedRule\"\n\t(constraint clearance (min 0.5mm)))";
1479 entry.wasEdited = true;
1480
1481 auto numericData = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>();
1482 numericData->SetRuleName( "EditedRule" );
1483 numericData->SetConstraintCode( "clearance" );
1484 numericData->SetNumericInputValue( 0.3 );
1485 entry.constraintData = numericData;
1486
1487 DRC_RULE_SAVER saver;
1488 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1489 wxString result = saver.GenerateRulesText( entries, nullptr );
1490
1491 // Original text should NOT be preserved since wasEdited is true
1492 BOOST_CHECK( !result.Contains( "0.5mm" ) );
1493 BOOST_CHECK( result.Contains( "EditedRule" ) );
1494}
1495
1496BOOST_AUTO_TEST_CASE( RuleSaverViaStyleRule )
1497{
1498 // Test: Via style rule generation
1500 entry.panelType = VIA_STYLE;
1501 entry.ruleName = "ViaTest";
1502
1503 auto viaData = std::make_shared<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>();
1504 viaData->SetRuleName( "ViaTest" );
1505 viaData->SetMinViaDiameter( 0.5 );
1506 viaData->SetMaxViaDiameter( 0.8 );
1507 viaData->SetMinViaHoleSize( 0.2 );
1508 viaData->SetMaxViaHoleSize( 0.4 );
1509 entry.constraintData = viaData;
1510 entry.wasEdited = true;
1511
1512 DRC_RULE_SAVER saver;
1513 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1514 wxString result = saver.GenerateRulesText( entries, nullptr );
1515
1516 BOOST_CHECK( result.Contains( "ViaTest" ) );
1517 BOOST_CHECK( result.Contains( "via_diameter" ) );
1518 BOOST_CHECK( result.Contains( "hole_size" ) );
1519}
1520
1521BOOST_AUTO_TEST_CASE( RuleSaverMultipleEntries )
1522{
1523 // Test: Multiple entries saved in order
1524 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries;
1525
1528 entry1.ruleName = "RuleA";
1529 auto data1 = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>();
1530 data1->SetRuleName( "RuleA" );
1531 data1->SetConstraintCode( "clearance" );
1532 data1->SetNumericInputValue( 0.2 );
1533 entry1.constraintData = data1;
1534 entry1.wasEdited = true;
1535 entries.push_back( entry1 );
1536
1538 entry2.panelType = ROUTING_WIDTH;
1539 entry2.ruleName = "RuleB";
1540 auto data2 = std::make_shared<DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA>();
1541 data2->SetRuleName( "RuleB" );
1542 data2->SetOptWidth( 0.2 );
1543 data2->SetWidthTolerance( 0.1 );
1544 entry2.constraintData = data2;
1545 entry2.wasEdited = true;
1546 entries.push_back( entry2 );
1547
1548 DRC_RULE_SAVER saver;
1549 wxString result = saver.GenerateRulesText( entries, nullptr );
1550
1551 // Both rules should appear
1552 BOOST_CHECK( result.Contains( "RuleA" ) );
1553 BOOST_CHECK( result.Contains( "RuleB" ) );
1554
1555 // Check order: RuleA should appear before RuleB
1556 size_t posA = result.Find( "RuleA" );
1557 size_t posB = result.Find( "RuleB" );
1558 BOOST_CHECK( posA < posB );
1559}
1560
1561BOOST_AUTO_TEST_CASE( RuleSaverWithCondition )
1562{
1563 // Test: Rule with condition
1566 entry.ruleName = "ConditionalRule";
1567 entry.condition = "A.NetClass == 'Power'";
1568
1569 auto numericData = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>();
1570 numericData->SetRuleName( "ConditionalRule" );
1571 numericData->SetConstraintCode( "clearance" );
1572 numericData->SetRuleCondition( "A.NetClass == 'Power'" );
1573 numericData->SetNumericInputValue( 0.3 );
1574 entry.constraintData = numericData;
1575 entry.wasEdited = true;
1576
1577 DRC_RULE_SAVER saver;
1578 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1579 wxString result = saver.GenerateRulesText( entries, nullptr );
1580
1581 BOOST_CHECK( result.Contains( "ConditionalRule" ) );
1582 BOOST_CHECK( result.Contains( "condition" ) );
1583 BOOST_CHECK( result.Contains( "Power" ) );
1584}
1585
1586BOOST_AUTO_TEST_CASE( RuleSaverEmptyEntries )
1587{
1588 // Test: Empty entries vector
1589 DRC_RULE_SAVER saver;
1590 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries;
1591 wxString result = saver.GenerateRulesText( entries, nullptr );
1592
1593 BOOST_CHECK( result.Contains( "(version 2)" ) );
1594 // Should have version header but nothing else
1595 BOOST_CHECK_EQUAL( result.Trim(), "(version 2)" );
1596}
1597
1598BOOST_AUTO_TEST_CASE( RuleSaverNullConstraintData )
1599{
1600 // Test: Entry with null constraint data is skipped
1603 entry.ruleName = "Null Data Rule";
1604 entry.constraintData = nullptr;
1605 entry.wasEdited = true;
1606
1607 DRC_RULE_SAVER saver;
1608 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1609 wxString result = saver.GenerateRulesText( entries, nullptr );
1610
1611 // Should have version header but rule text is skipped
1612 BOOST_CHECK( result.Contains( "(version 2)" ) );
1613 BOOST_CHECK( !result.Contains( "Null Data Rule" ) );
1614}
1615
1616BOOST_AUTO_TEST_CASE( RuleSaverLoadSaveRoundTrip )
1617{
1618 // Test: Full round-trip: Load → mark edited → Save → Load produces equivalent data
1619 wxString originalText =
1620 "(version 1)\n"
1621 "(rule \"RoundTripTest\"\n"
1622 " (constraint clearance (min 0.25mm)))";
1623
1624 DRC_RULE_LOADER loader;
1625 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( originalText );
1626
1627 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1628 BOOST_CHECK_EQUAL( entries[0].ruleName, "RoundTripTest" );
1629
1630 // Mark as edited so it regenerates from data (loader doesn't preserve exact original text)
1631 entries[0].wasEdited = true;
1632
1633 // Save
1634 DRC_RULE_SAVER saver;
1635 wxString savedText = saver.GenerateRulesText( entries, nullptr );
1636
1637 // Verify saved text is valid by reloading
1638 std::vector<DRC_RE_LOADED_PANEL_ENTRY> reloadedEntries = loader.LoadFromString( savedText );
1639
1640 BOOST_REQUIRE_EQUAL( reloadedEntries.size(), 1 );
1641 BOOST_CHECK_EQUAL( reloadedEntries[0].ruleName, "RoundTripTest" );
1642 BOOST_CHECK_EQUAL( reloadedEntries[0].panelType, entries[0].panelType );
1643}
1644
1645BOOST_AUTO_TEST_CASE( RuleSaverPreservesQuotedNameWithSpaces )
1646{
1647 // Issue 23852: editing a rule named like "Annular width: LEDs" must not rewrite
1648 // the name to Annular_width__LEDs. Names with whitespace or other characters
1649 // that require quoting must be emitted as a quoted string and round-trip intact.
1650 const wxString originalName = wxS( "Annular width: LEDs" );
1651
1654 entry.ruleName = originalName;
1655 entry.wasEdited = true;
1656
1657 auto numericData = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>();
1658 numericData->SetRuleName( originalName );
1659 numericData->SetConstraintCode( "annular_width" );
1660 numericData->SetNumericInputValue( 0.085 );
1661 entry.constraintData = numericData;
1662
1663 DRC_RULE_SAVER saver;
1664 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1665 wxString result = saver.GenerateRulesText( entries, nullptr );
1666
1667 // The saver must emit the name in quotes, not mangle it with underscores.
1668 BOOST_CHECK( result.Contains( wxS( "\"Annular width: LEDs\"" ) ) );
1669 BOOST_CHECK( !result.Contains( wxS( "Annular_width__LEDs" ) ) );
1670
1671 // Reload the saved text and verify the rule name survives unchanged.
1672 DRC_RULE_LOADER loader;
1673 std::vector<DRC_RE_LOADED_PANEL_ENTRY> reloaded = loader.LoadFromString( result );
1674
1675 BOOST_REQUIRE_EQUAL( reloaded.size(), 1 );
1676 BOOST_CHECK_EQUAL( reloaded[0].ruleName, originalName );
1677}
1678
1679
1680BOOST_AUTO_TEST_CASE( RuleSaverPreservesBareSymbolNameUnquoted )
1681{
1682 // A bare symbol rule name should still be emitted without quotes.
1685 entry.ruleName = wxS( "My_Bare_Rule-1.0" );
1686 entry.wasEdited = true;
1687
1688 auto numericData = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>();
1689 numericData->SetRuleName( entry.ruleName );
1690 numericData->SetConstraintCode( "clearance" );
1691 numericData->SetNumericInputValue( 0.2 );
1692 entry.constraintData = numericData;
1693
1694 DRC_RULE_SAVER saver;
1695 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1696 wxString result = saver.GenerateRulesText( entries, nullptr );
1697
1698 BOOST_CHECK( result.Contains( wxS( "(rule My_Bare_Rule-1.0\n" ) ) );
1699 BOOST_CHECK( !result.Contains( wxS( "\"My_Bare_Rule-1.0\"" ) ) );
1700}
1701
1702
1703BOOST_AUTO_TEST_CASE( RuleSaverQuotesNameStartingWithDigit )
1704{
1705 // Names starting with a digit must be quoted so S-expression parsers treat them
1706 // as a symbol rather than a numeric literal.
1709 entry.ruleName = wxS( "3.3V_Power" );
1710 entry.wasEdited = true;
1711
1712 auto numericData = std::make_shared<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>();
1713 numericData->SetRuleName( entry.ruleName );
1714 numericData->SetConstraintCode( "clearance" );
1715 numericData->SetNumericInputValue( 0.2 );
1716 entry.constraintData = numericData;
1717
1718 DRC_RULE_SAVER saver;
1719 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1720 wxString result = saver.GenerateRulesText( entries, nullptr );
1721
1722 BOOST_CHECK( result.Contains( wxS( "\"3.3V_Power\"" ) ) );
1723
1724 DRC_RULE_LOADER loader;
1725 std::vector<DRC_RE_LOADED_PANEL_ENTRY> reloaded = loader.LoadFromString( result );
1726 BOOST_REQUIRE_EQUAL( reloaded.size(), 1 );
1727 BOOST_CHECK_EQUAL( reloaded[0].ruleName, "3.3V_Power" );
1728}
1729
1730
1731BOOST_AUTO_TEST_CASE( RuleSaverDiffPairRule )
1732{
1733 // Test: Diff pair rule generation
1736 entry.ruleName = "DiffPairTest";
1737
1738 auto dpData = std::make_shared<DRC_RE_ROUTING_DIFF_PAIR_CONSTRAINT_DATA>();
1739 dpData->SetRuleName( "DiffPairTest" );
1740 dpData->SetOptWidth( 0.25 );
1741 dpData->SetWidthTolerance( 0.05 );
1742 dpData->SetOptGap( 0.15 );
1743 dpData->SetGapTolerance( 0.05 );
1744 dpData->SetMaxUncoupledLength( 5.0 );
1745 entry.constraintData = dpData;
1746 entry.wasEdited = true;
1747
1748 DRC_RULE_SAVER saver;
1749 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
1750 wxString result = saver.GenerateRulesText( entries, nullptr );
1751
1752 BOOST_CHECK( result.Contains( "DiffPairTest" ) );
1753 BOOST_CHECK( result.Contains( "track_width" ) );
1754 BOOST_CHECK( result.Contains( "diff_pair_gap" ) );
1755}
1756
1757
1758// ============================================================================
1759// Integration Tests (Phase 5.2)
1760// ============================================================================
1761
1762BOOST_AUTO_TEST_CASE( IntegrationLoadHoleClearanceRules )
1763{
1764 // Test: Load issue6879.kicad_dru which has hole_clearance and hole constraints
1765 wxString ruleText =
1766 "(version 1)\n"
1767 "(rule \"PTH to Track Clearance\"\n"
1768 " (constraint hole_clearance (min 1.0mm))\n"
1769 " (condition \"A.Type == 'Pad' && A.Pad_Type == 'Through-hole' && B.Type =='Track'\"))\n"
1770 "(rule \"Max Drill Hole Size Mechanical\"\n"
1771 " (constraint hole (max 2.0mm))\n"
1772 " (condition \"A.Type == 'Pad'\"))";
1773
1774 DRC_RULE_LOADER loader;
1775 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1776
1777 BOOST_REQUIRE_GE( entries.size(), 2 );
1778
1779 // First rule should be COPPER_TO_HOLE_CLEARANCE
1780 BOOST_CHECK_EQUAL( entries[0].panelType, COPPER_TO_HOLE_CLEARANCE );
1781 BOOST_CHECK_EQUAL( entries[0].ruleName, "PTH to Track Clearance" );
1782 BOOST_CHECK( !entries[0].condition.IsEmpty() );
1783
1784 // Second rule should be HOLE_SIZE
1785 BOOST_CHECK_EQUAL( entries[1].panelType, HOLE_SIZE );
1786 BOOST_CHECK_EQUAL( entries[1].ruleName, "Max Drill Hole Size Mechanical" );
1787}
1788
1789BOOST_AUTO_TEST_CASE( IntegrationLoadEdgeClearanceWithSeverity )
1790{
1791 // Test: Load severities.kicad_dru which has severity clause
1792 wxString ruleText =
1793 "(version 1)\n"
1794 "(rule board_edge\n"
1795 " (constraint edge_clearance (min 1mm))\n"
1796 " (condition \"A.memberOf('board_edge')\")\n"
1797 " (severity ignore))";
1798
1799 DRC_RULE_LOADER loader;
1800 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1801
1802 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1803 BOOST_CHECK_EQUAL( entries[0].panelType, COPPER_TO_EDGE_CLEARANCE );
1804 BOOST_CHECK_EQUAL( entries[0].ruleName, "board_edge" );
1805 BOOST_CHECK_EQUAL( entries[0].severity, RPT_SEVERITY_IGNORE );
1806}
1807
1808BOOST_AUTO_TEST_CASE( IntegrationLoadConnectionWidthRules )
1809{
1810 // Test: Load connection_width_rules.kicad_dru
1811 wxString ruleText =
1812 "(version 1)\n"
1813 "(rule high_current_netclass\n"
1814 " (constraint connection_width (min 0.16mm))\n"
1815 " (condition \"A.NetClass == 'High_current'\"))\n"
1816 "(rule high_current_area\n"
1817 " (constraint connection_width (min 0.16mm))\n"
1818 " (condition \"A.insideArea('high_current')\"))";
1819
1820 DRC_RULE_LOADER loader;
1821 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1822
1823 BOOST_REQUIRE_EQUAL( entries.size(), 2 );
1824
1825 // Both should be MINIMUM_CONNECTION_WIDTH
1826 BOOST_CHECK_EQUAL( entries[0].panelType, MINIMUM_CONNECTION_WIDTH );
1827 BOOST_CHECK_EQUAL( entries[1].panelType, MINIMUM_CONNECTION_WIDTH );
1828
1829 // Both should have conditions
1830 BOOST_CHECK( !entries[0].condition.IsEmpty() );
1831 BOOST_CHECK( !entries[1].condition.IsEmpty() );
1832}
1833
1834BOOST_AUTO_TEST_CASE( IntegrationSaveLoadRoundTripMultipleRules )
1835{
1836 // Test: Load multiple rules, save, reload - verify equivalent data
1837 // Use rule names without spaces to avoid sanitization differences
1838 wxString originalText =
1839 "(version 1)\n"
1840 "(rule ClearanceRule\n"
1841 " (constraint clearance (min 0.2mm))\n"
1842 " (condition \"A.NetClass == 'Power'\"))\n"
1843 "(rule TrackWidthRule\n"
1844 " (constraint track_width (min 0.15mm) (opt 0.2mm) (max 0.3mm)))";
1845
1846 DRC_RULE_LOADER loader;
1847 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( originalText );
1848
1849 BOOST_REQUIRE_EQUAL( entries.size(), 2 );
1850
1851 // Mark as edited to force regeneration
1852 for( auto& entry : entries )
1853 entry.wasEdited = true;
1854
1855 // Save
1856 DRC_RULE_SAVER saver;
1857 wxString savedText = saver.GenerateRulesText( entries, nullptr );
1858
1859 // Reload
1860 std::vector<DRC_RE_LOADED_PANEL_ENTRY> reloadedEntries = loader.LoadFromString( savedText );
1861
1862 BOOST_REQUIRE_EQUAL( reloadedEntries.size(), 2 );
1863
1864 // Verify panel types preserved correctly
1865 BOOST_CHECK_EQUAL( reloadedEntries[0].panelType, entries[0].panelType );
1866 BOOST_CHECK_EQUAL( reloadedEntries[1].panelType, entries[1].panelType );
1867
1868 // Verify rule names preserved
1869 BOOST_CHECK_EQUAL( reloadedEntries[0].ruleName, "ClearanceRule" );
1870 BOOST_CHECK_EQUAL( reloadedEntries[1].ruleName, "TrackWidthRule" );
1871}
1872
1873BOOST_AUTO_TEST_CASE( IntegrationSaveLoadViaStyleRoundTrip )
1874{
1875 // Test: Via style rules round-trip correctly
1876 wxString originalText =
1877 "(version 1)\n"
1878 "(rule \"Via Style\"\n"
1879 " (constraint via_diameter (min 0.5mm) (opt 0.6mm) (max 0.8mm))\n"
1880 " (constraint hole_size (min 0.2mm) (opt 0.3mm) (max 0.4mm)))";
1881
1882 DRC_RULE_LOADER loader;
1883 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( originalText );
1884
1885 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
1886 BOOST_CHECK_EQUAL( entries[0].panelType, VIA_STYLE );
1887
1888 auto viaData = std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( entries[0].constraintData );
1889 BOOST_REQUIRE( viaData );
1890
1891 double originalMinDia = viaData->GetMinViaDiameter();
1892 double originalMinHole = viaData->GetMinViaHoleSize();
1893
1894 // Mark as edited and save
1895 entries[0].wasEdited = true;
1896 DRC_RULE_SAVER saver;
1897 wxString savedText = saver.GenerateRulesText( entries, nullptr );
1898
1899 // Reload and verify values preserved
1900 std::vector<DRC_RE_LOADED_PANEL_ENTRY> reloadedEntries = loader.LoadFromString( savedText );
1901
1902 BOOST_REQUIRE_EQUAL( reloadedEntries.size(), 1 );
1903 BOOST_CHECK_EQUAL( reloadedEntries[0].panelType, VIA_STYLE );
1904
1905 auto reloadedViaData =
1906 std::dynamic_pointer_cast<DRC_RE_VIA_STYLE_CONSTRAINT_DATA>( reloadedEntries[0].constraintData );
1907 BOOST_REQUIRE( reloadedViaData );
1908
1909 BOOST_CHECK_CLOSE( reloadedViaData->GetMinViaDiameter(), originalMinDia, 0.0001 );
1910 BOOST_CHECK_CLOSE( reloadedViaData->GetMinViaHoleSize(), originalMinHole, 0.0001 );
1911}
1912
1913BOOST_AUTO_TEST_CASE( IntegrationSplitRulePreservesOrder )
1914{
1915 // Test: A rule with multiple constraint types splits and preserves order
1916 wxString ruleText =
1917 "(version 1)\n"
1918 "(rule \"Rule A\"\n"
1919 " (constraint clearance (min 0.2mm)))\n"
1920 "(rule \"Rule B\"\n"
1921 " (constraint via_diameter (min 0.5mm))\n"
1922 " (constraint hole_size (min 0.2mm))\n"
1923 " (constraint track_width (min 0.15mm)))\n"
1924 "(rule \"Rule C\"\n"
1925 " (constraint edge_clearance (min 0.3mm)))";
1926
1927 DRC_RULE_LOADER loader;
1928 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
1929
1930 // Rule B splits into VIA_STYLE and ROUTING_WIDTH
1931 BOOST_REQUIRE_GE( entries.size(), 4 );
1932
1933 // Find entries by rule name
1934 int ruleACount = 0, ruleBCount = 0, ruleCCount = 0;
1935
1936 for( const auto& entry : entries )
1937 {
1938 if( entry.ruleName == "Rule A" )
1939 ruleACount++;
1940 else if( entry.ruleName == "Rule B" )
1941 ruleBCount++;
1942 else if( entry.ruleName == "Rule C" )
1943 ruleCCount++;
1944 }
1945
1946 BOOST_CHECK_EQUAL( ruleACount, 1 );
1947 BOOST_CHECK_GE( ruleBCount, 2 );
1948 BOOST_CHECK_EQUAL( ruleCCount, 1 );
1949
1950 // Verify original order: all Rule A entries before Rule B, Rule B before Rule C
1951 int lastAIndex = -1, firstBIndex = entries.size(), lastBIndex = -1, firstCIndex = entries.size();
1952
1953 for( size_t i = 0; i < entries.size(); i++ )
1954 {
1955 if( entries[i].ruleName == "Rule A" )
1956 lastAIndex = i;
1957 else if( entries[i].ruleName == "Rule B" )
1958 {
1959 if( (int)i < firstBIndex )
1960 firstBIndex = i;
1961
1962 lastBIndex = i;
1963 }
1964 else if( entries[i].ruleName == "Rule C" )
1965 {
1966 if( (int)i < firstCIndex )
1967 firstCIndex = i;
1968 }
1969 }
1970
1971 BOOST_CHECK( lastAIndex < firstBIndex );
1972 BOOST_CHECK( lastBIndex < firstCIndex );
1973}
1974
1975
1976// ============================================================================
1977// Condition Group Panel Tests
1978// ============================================================================
1979
1980BOOST_AUTO_TEST_CASE( ConditionGroupBuildSingleCondition )
1981{
1982 // Test: Single condition builds correctly
1983 // This tests the expression building logic used by DRC_RE_CONDITION_GROUP_PANEL
1984 wxString expr = "A.NetName == 'VCC'";
1985
1986 // When parsed and rebuilt, the result should be equivalent
1987 BOOST_CHECK( !expr.IsEmpty() );
1988 BOOST_CHECK( expr.Contains( "NetName" ) );
1989 BOOST_CHECK( expr.Contains( "VCC" ) );
1990}
1991
1992BOOST_AUTO_TEST_CASE( ConditionGroupTokenizeAndOperator )
1993{
1994 // Test: Tokenizing conditions with AND operator
1995 wxString expr = "A.NetName == 'VCC' && B.NetClass == 'Power'";
1996
1997 // Verify the expression contains expected operators
1998 BOOST_CHECK( expr.Contains( "&&" ) );
1999 BOOST_CHECK( expr.Contains( "NetName" ) );
2000 BOOST_CHECK( expr.Contains( "NetClass" ) );
2001}
2002
2003BOOST_AUTO_TEST_CASE( ConditionGroupTokenizeOrOperator )
2004{
2005 // Test: Tokenizing conditions with OR operator
2006 wxString expr = "A.intersectsArea('underFPGA') || A.intersectsArea('underDDR')";
2007
2008 // Verify the expression contains expected operators
2009 BOOST_CHECK( expr.Contains( "||" ) );
2010 BOOST_CHECK( expr.Contains( "intersectsArea" ) );
2011}
2012
2013BOOST_AUTO_TEST_CASE( ConditionGroupTokenizeAndNotOperator )
2014{
2015 // Test: Tokenizing conditions with AND NOT operator
2016 wxString expr = "A.NetClass == 'Power' && !A.intersectsArea('NoRouting')";
2017
2018 // Verify the expression contains expected operators and negation
2019 BOOST_CHECK( expr.Contains( "&&" ) );
2020 BOOST_CHECK( expr.Contains( "!" ) );
2021}
2022
2023BOOST_AUTO_TEST_CASE( ConditionGroupTokenizeComplexExpression )
2024{
2025 // Test: Complex expression from vme-wren.kicad_dru
2026 wxString expr = "A.intersectsArea('underFPGA') || A.intersectsArea('underDDR')";
2027
2028 // The expression should contain the expected patterns
2029 BOOST_CHECK( expr.Contains( "||" ) );
2030 BOOST_CHECK( expr.Contains( "underFPGA" ) );
2031 BOOST_CHECK( expr.Contains( "underDDR" ) );
2032
2033 // Count number of conditions (2 in this case)
2034 size_t orCount = 0;
2035 size_t pos = 0;
2036
2037 while( ( pos = expr.find( "||", pos ) ) != wxString::npos )
2038 {
2039 orCount++;
2040 pos += 2;
2041 }
2042
2043 BOOST_CHECK_EQUAL( orCount, 1 );
2044}
2045
2046
2047// ============================================================================
2048// DRC Engine Item Filtering Tests
2049// ============================================================================
2050
2051BOOST_AUTO_TEST_CASE( ItemFilterExcludesNetInfoAndGenerator )
2052{
2053 // Test: Verify the item type filter logic matches expected exclusions
2054 // This is a unit test for the switch statement in GetItemsMatchingCondition
2055
2056 std::vector<KICAD_T> excludedTypes = { PCB_NETINFO_T, PCB_GENERATOR_T, PCB_GROUP_T };
2057 std::vector<KICAD_T> includedTypes = { PCB_TRACE_T, PCB_VIA_T, PCB_PAD_T, PCB_FOOTPRINT_T,
2059
2060 for( KICAD_T type : excludedTypes )
2061 {
2062 switch( type )
2063 {
2064 case PCB_NETINFO_T:
2065 case PCB_GENERATOR_T:
2066 case PCB_GROUP_T:
2067 BOOST_CHECK( true ); // These should be excluded (continue in real code)
2068 break;
2069
2070 default:
2071 BOOST_FAIL( "Excluded type not handled in filter" );
2072 break;
2073 }
2074 }
2075
2076 for( KICAD_T type : includedTypes )
2077 {
2078 switch( type )
2079 {
2080 case PCB_NETINFO_T:
2081 case PCB_GENERATOR_T:
2082 case PCB_GROUP_T:
2083 BOOST_FAIL( "Included type incorrectly matched by filter" );
2084 break;
2085
2086 default:
2087 BOOST_CHECK( true ); // These should be included
2088 break;
2089 }
2090 }
2091}
2092
2093BOOST_AUTO_TEST_CASE( RuleSaverSilkToSoldermaskWithCondition )
2094{
2095 // Test: Silk-to-soldermask merges layer condition with user condition
2096 // into a single (condition ...) clause, not two separate ones.
2099 entry.ruleName = "SilkMaskTest";
2100 entry.condition = "A.NetClass == 'Power'";
2101 entry.wasEdited = true;
2102 entry.layerCondition = LSET( { F_SilkS } );
2103
2104 auto data = std::make_shared<DRC_RE_SILK_TO_SOLDERMASK_CLEARANCE_CONSTRAINT_DATA>();
2105 data->SetRuleName( "SilkMaskTest" );
2106 data->SetConstraintCode( "silk_clearance" );
2107 data->SetRuleCondition( "A.NetClass == 'Power'" );
2108 data->SetNumericInputValue( 0.15 );
2109 entry.constraintData = data;
2110
2111 DRC_RULE_SAVER saver;
2112 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
2113 wxString result = saver.GenerateRulesText( entries, nullptr );
2114
2115 // Should have a single merged condition, not two (condition ...) lines
2116 BOOST_CHECK( result.Contains( "L == 'F.Mask'" ) );
2117 BOOST_CHECK( result.Contains( "Power" ) );
2118 BOOST_CHECK( !result.Contains( "(layer" ) );
2119
2120 // Count occurrences of "(condition" — must be exactly one
2121 int condCount = 0;
2122 size_t pos = 0;
2123 while( ( pos = result.find( "(condition", pos ) ) != wxString::npos )
2124 {
2125 condCount++;
2126 pos++;
2127 }
2128 BOOST_CHECK_EQUAL( condCount, 1 );
2129}
2130
2131BOOST_AUTO_TEST_CASE( RuleSaverSilkToSoldermaskNoExtraCondition )
2132{
2133 // Test: Silk-to-soldermask without extra condition still produces
2134 // a condition clause, not a (layer ...) clause.
2137 entry.ruleName = "SilkMaskSimple";
2138 entry.wasEdited = true;
2139 entry.layerCondition = LSET( { B_SilkS } );
2140
2141 auto data = std::make_shared<DRC_RE_SILK_TO_SOLDERMASK_CLEARANCE_CONSTRAINT_DATA>();
2142 data->SetRuleName( "SilkMaskSimple" );
2143 data->SetConstraintCode( "silk_clearance" );
2144 data->SetNumericInputValue( 0.1 );
2145 entry.constraintData = data;
2146
2147 DRC_RULE_SAVER saver;
2148 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
2149 wxString result = saver.GenerateRulesText( entries, nullptr );
2150
2151 BOOST_CHECK( result.Contains( "L == 'B.Mask'" ) );
2152 BOOST_CHECK( result.Contains( "(condition" ) );
2153 BOOST_CHECK( !result.Contains( "(layer" ) );
2154}
2155
2156BOOST_AUTO_TEST_CASE( RuleSaverSilkToSilkBothLayers )
2157{
2158 // Silk-to-silk with both layers generates L == 'F.SilkS' || L == 'B.SilkS'
2161 entry.ruleName = "SilkSilkBoth";
2162 entry.wasEdited = true;
2163 entry.layerCondition = LSET( { F_SilkS, B_SilkS } );
2164
2165 auto data = std::make_shared<DRC_RE_SILK_TO_SILK_CLEARANCE_CONSTRAINT_DATA>();
2166 data->SetRuleName( "SilkSilkBoth" );
2167 data->SetConstraintCode( "silk_clearance" );
2168 data->SetNumericInputValue( 0.2 );
2169 entry.constraintData = data;
2170
2171 DRC_RULE_SAVER saver;
2172 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
2173 wxString result = saver.GenerateRulesText( entries, nullptr );
2174
2175 BOOST_CHECK( result.Contains( "L == 'F.SilkS' || L == 'B.SilkS'" ) );
2176 BOOST_CHECK( result.Contains( "(condition" ) );
2177 BOOST_CHECK( !result.Contains( "(layer" ) );
2178}
2179
2180BOOST_AUTO_TEST_CASE( RuleSaverSilkToSilkFrontOnly )
2181{
2182 // Silk-to-silk front only generates L == 'F.SilkS'
2185 entry.ruleName = "SilkSilkFront";
2186 entry.wasEdited = true;
2187 entry.layerCondition = LSET( { F_SilkS } );
2188
2189 auto data = std::make_shared<DRC_RE_SILK_TO_SILK_CLEARANCE_CONSTRAINT_DATA>();
2190 data->SetRuleName( "SilkSilkFront" );
2191 data->SetConstraintCode( "silk_clearance" );
2192 data->SetNumericInputValue( 0.2 );
2193 entry.constraintData = data;
2194
2195 DRC_RULE_SAVER saver;
2196 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
2197 wxString result = saver.GenerateRulesText( entries, nullptr );
2198
2199 BOOST_CHECK( result.Contains( "L == 'F.SilkS'" ) );
2200 BOOST_CHECK( !result.Contains( "B.SilkS" ) );
2201 BOOST_CHECK( result.Contains( "(condition" ) );
2202 BOOST_CHECK( !result.Contains( "(layer" ) );
2203}
2204
2205BOOST_AUTO_TEST_CASE( RuleSaverSilkToSilkWithCondition )
2206{
2207 // Silk-to-silk merges layer condition with user condition
2210 entry.ruleName = "SilkSilkCond";
2211 entry.condition = "A.NetClass == 'Signal'";
2212 entry.wasEdited = true;
2213 entry.layerCondition = LSET( { F_SilkS } );
2214
2215 auto data = std::make_shared<DRC_RE_SILK_TO_SILK_CLEARANCE_CONSTRAINT_DATA>();
2216 data->SetRuleName( "SilkSilkCond" );
2217 data->SetConstraintCode( "silk_clearance" );
2218 data->SetRuleCondition( "A.NetClass == 'Signal'" );
2219 data->SetNumericInputValue( 0.2 );
2220 entry.constraintData = data;
2221
2222 DRC_RULE_SAVER saver;
2223 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = { entry };
2224 wxString result = saver.GenerateRulesText( entries, nullptr );
2225
2226 BOOST_CHECK( result.Contains( "L == 'F.SilkS'" ) );
2227 BOOST_CHECK( result.Contains( "Signal" ) );
2228
2229 // Single merged condition
2230 int condCount = 0;
2231 size_t pos = 0;
2232 while( ( pos = result.find( "(condition", pos ) ) != wxString::npos )
2233 {
2234 condCount++;
2235 pos++;
2236 }
2237 BOOST_CHECK_EQUAL( condCount, 1 );
2238}
2239
2240BOOST_AUTO_TEST_CASE( ValidateViasUnderSmdValid )
2241{
2242 // Valid: at least one via type is selected
2243 DRC_RE_VIAS_UNDER_SMD_CONSTRAINT_DATA data1( 0, 0, "OnlyMicro", false, true, false, false );
2244 VALIDATION_RESULT result1 = data1.Validate();
2245 BOOST_CHECK( result1.isValid );
2246 BOOST_CHECK( result1.errors.empty() );
2247
2248 // Valid: all selected
2249 DRC_RE_VIAS_UNDER_SMD_CONSTRAINT_DATA data2( 0, 0, "AllVias", true, true, true, true );
2250 VALIDATION_RESULT result2 = data2.Validate();
2251 BOOST_CHECK( result2.isValid );
2252 BOOST_CHECK( result2.errors.empty() );
2253}
2254
2255BOOST_AUTO_TEST_CASE( ValidateViasUnderSmdInvalid )
2256{
2257 // Invalid: no via type selected
2258 DRC_RE_VIAS_UNDER_SMD_CONSTRAINT_DATA data( 0, 0, "NoneSelected", false, false, false, false );
2260 BOOST_CHECK( !result.isValid );
2261 BOOST_CHECK( !result.errors.empty() );
2262
2263 bool foundError = false;
2264 for( const auto& error : result.errors )
2265 {
2266 if( error.find( "At least one via type must be selected" ) != std::string::npos )
2267 foundError = true;
2268 }
2269 BOOST_CHECK( foundError );
2270}
2271
2272BOOST_AUTO_TEST_CASE( ViasUnderSmdClauseGeneration )
2273{
2275 ctx.ruleName = "TestRule";
2276 ctx.constraintCode = "disallow_via";
2277
2278 // All four selected - shorthand "via" used
2279 DRC_RE_VIAS_UNDER_SMD_CONSTRAINT_DATA allData( 0, 0, "AllRule", true, true, true, true );
2280 auto clauses = allData.GetConstraintClauses( ctx );
2281 BOOST_REQUIRE_EQUAL( clauses.size(), 1 );
2282 BOOST_CHECK( clauses[0].Contains( "disallow via" ) );
2283 BOOST_CHECK( !clauses[0].Contains( "through_via" ) );
2284
2285 // Only micro_via selected - specific token
2286 DRC_RE_VIAS_UNDER_SMD_CONSTRAINT_DATA microOnly( 0, 0, "MicroRule", false, true, false, false );
2287 clauses = microOnly.GetConstraintClauses( ctx );
2288 BOOST_REQUIRE_EQUAL( clauses.size(), 1 );
2289 BOOST_CHECK( clauses[0].Contains( "micro_via" ) );
2290 BOOST_CHECK( !clauses[0].Contains( "through_via" ) );
2291 BOOST_CHECK( !clauses[0].Contains( "blind_via" ) );
2292 BOOST_CHECK( !clauses[0].Contains( "buried_via" ) );
2293
2294 // Through + blind selected - both tokens, no shorthand
2295 DRC_RE_VIAS_UNDER_SMD_CONSTRAINT_DATA twoTypes( 0, 0, "TwoRule", true, false, true, false );
2296 clauses = twoTypes.GetConstraintClauses( ctx );
2297 BOOST_REQUIRE_EQUAL( clauses.size(), 1 );
2298 BOOST_CHECK( clauses[0].Contains( "through_via" ) );
2299 BOOST_CHECK( clauses[0].Contains( "blind_via" ) );
2300 BOOST_CHECK( !clauses[0].Contains( "micro_via" ) );
2301 BOOST_CHECK( !clauses[0].Contains( "buried_via" ) );
2302
2303 // None selected - empty
2304 DRC_RE_VIAS_UNDER_SMD_CONSTRAINT_DATA noneData( 0, 0, "NoneRule", false, false, false, false );
2305 clauses = noneData.GetConstraintClauses( ctx );
2306 BOOST_CHECK( clauses.empty() );
2307}
2308
2309BOOST_AUTO_TEST_CASE( IntegrationViasUnderSmdRoundTrip )
2310{
2311 // Load a rule with only micro_via disallowed
2312 wxString originalText = "(version 1)\n"
2313 "(rule \"ViasUnderSmdTest\"\n"
2314 " (constraint disallow micro_via)\n"
2315 " (condition \"A.Pad_Type == 'SMD' && A.insideArea('BGA*')\"))";
2316
2317 DRC_RULE_LOADER loader;
2318 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( originalText );
2319
2320 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
2321 BOOST_CHECK_EQUAL( entries[0].panelType, VIAS_UNDER_SMD );
2322
2323 auto viaData = std::dynamic_pointer_cast<DRC_RE_VIAS_UNDER_SMD_CONSTRAINT_DATA>( entries[0].constraintData );
2324 BOOST_REQUIRE( viaData );
2325
2326 // Only micro_via should be checked
2327 BOOST_CHECK( !viaData->GetDisallowThroughVias() );
2328 BOOST_CHECK( viaData->GetDisallowMicroVias() );
2329 BOOST_CHECK( !viaData->GetDisallowBlindVias() );
2330 BOOST_CHECK( !viaData->GetDisallowBuriedVias() );
2331
2332 // Mark as edited and save
2333 entries[0].wasEdited = true;
2334 DRC_RULE_SAVER saver;
2335 wxString savedText = saver.GenerateRulesText( entries, nullptr );
2336
2337 // Verify saved text preserves specific via type (not blanket "via")
2338 BOOST_CHECK( savedText.Contains( "micro_via" ) );
2339 BOOST_CHECK( !savedText.Contains( "through_via" ) );
2340 BOOST_CHECK( !savedText.Contains( "blind_via" ) );
2341 BOOST_CHECK( !savedText.Contains( "buried_via" ) );
2342
2343 // Reload and verify roundtrip
2344 std::vector<DRC_RE_LOADED_PANEL_ENTRY> reloadedEntries = loader.LoadFromString( savedText );
2345 BOOST_REQUIRE_EQUAL( reloadedEntries.size(), 1 );
2346
2347 auto reloadedData =
2348 std::dynamic_pointer_cast<DRC_RE_VIAS_UNDER_SMD_CONSTRAINT_DATA>( reloadedEntries[0].constraintData );
2349 BOOST_REQUIRE( reloadedData );
2350
2351 BOOST_CHECK( !reloadedData->GetDisallowThroughVias() );
2352 BOOST_CHECK( reloadedData->GetDisallowMicroVias() );
2353 BOOST_CHECK( !reloadedData->GetDisallowBlindVias() );
2354 BOOST_CHECK( !reloadedData->GetDisallowBuriedVias() );
2355
2356 // Test blanket "via" sets all four flags
2357 wxString blanketText = "(version 1)\n"
2358 "(rule \"BlanketVia\"\n"
2359 " (constraint disallow via)\n"
2360 " (condition \"A.Pad_Type == 'SMD' && A.insideArea('BGA*')\"))";
2361
2362 entries = loader.LoadFromString( blanketText );
2363 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
2364
2365 auto blanketData = std::dynamic_pointer_cast<DRC_RE_VIAS_UNDER_SMD_CONSTRAINT_DATA>( entries[0].constraintData );
2366 BOOST_REQUIRE( blanketData );
2367
2368 BOOST_CHECK( blanketData->GetDisallowThroughVias() );
2369 BOOST_CHECK( blanketData->GetDisallowMicroVias() );
2370 BOOST_CHECK( blanketData->GetDisallowBlindVias() );
2371 BOOST_CHECK( blanketData->GetDisallowBuriedVias() );
2372
2373 // Test multiple specific types roundtrip
2374 wxString multiText = "(version 1)\n"
2375 "(rule \"TwoVias\"\n"
2376 " (constraint disallow through_via blind_via)\n"
2377 " (condition \"A.Pad_Type == 'SMD' && A.insideArea('BGA*')\"))";
2378
2379 entries = loader.LoadFromString( multiText );
2380 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
2381
2382 auto multiData = std::dynamic_pointer_cast<DRC_RE_VIAS_UNDER_SMD_CONSTRAINT_DATA>( entries[0].constraintData );
2383 BOOST_REQUIRE( multiData );
2384
2385 BOOST_CHECK( multiData->GetDisallowThroughVias() );
2386 BOOST_CHECK( !multiData->GetDisallowMicroVias() );
2387 BOOST_CHECK( multiData->GetDisallowBlindVias() );
2388 BOOST_CHECK( !multiData->GetDisallowBuriedVias() );
2389
2390 entries[0].wasEdited = true;
2391 savedText = saver.GenerateRulesText( entries, nullptr );
2392
2393 BOOST_CHECK( savedText.Contains( "through_via" ) );
2394 BOOST_CHECK( savedText.Contains( "blind_via" ) );
2395 BOOST_CHECK( !savedText.Contains( "micro_via" ) );
2396 BOOST_CHECK( !savedText.Contains( "buried_via" ) );
2397}
2398
2399BOOST_AUTO_TEST_CASE( RuleLoaderNonStandardOrientationFallsBackToCustom )
2400{
2401 // Quoted name
2402 wxString ruleText = "(version 1)\n"
2403 "(rule \"Angled\"\n"
2404 " (constraint assertion \"A.Orientation == 46 deg\")\n"
2405 ")";
2406
2407 DRC_RULE_LOADER loader;
2408 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
2409
2410 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
2411 BOOST_CHECK_EQUAL( entries[0].panelType, CUSTOM_RULE );
2412
2413 auto customData = std::dynamic_pointer_cast<DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA>( entries[0].constraintData );
2414 BOOST_REQUIRE( customData );
2415 BOOST_CHECK( customData->GetRuleText().Contains( wxS( "46 deg" ) ) );
2416 BOOST_CHECK( !customData->GetRuleText().Contains( wxS( "Angled" ) ) );
2417
2418 // Unquoted name
2419 wxString ruleTextUnquoted = "(version 1)\n"
2420 "(rule Angled\n"
2421 " (constraint assertion \"A.Orientation == 46 deg\")\n"
2422 ")";
2423
2424 entries = loader.LoadFromString( ruleTextUnquoted );
2425
2426 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
2427 BOOST_CHECK_EQUAL( entries[0].panelType, CUSTOM_RULE );
2428
2429 auto customDataUnquoted =
2430 std::dynamic_pointer_cast<DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA>( entries[0].constraintData );
2431 BOOST_REQUIRE( customDataUnquoted );
2432 BOOST_CHECK( customDataUnquoted->GetRuleText().Contains( wxS( "46 deg" ) ) );
2433 BOOST_CHECK( !customDataUnquoted->GetRuleText().Contains( wxS( "Angled" ) ) );
2434}
2435
2436BOOST_AUTO_TEST_CASE( RuleLoaderStandardOrientationLoadsStructured )
2437{
2438 wxString ruleText = "(version 1)\n"
2439 "(rule \"Standard\"\n"
2440 " (constraint assertion \"A.Orientation == 0 deg || A.Orientation == 90 deg\")\n"
2441 ")";
2442
2443 DRC_RULE_LOADER loader;
2444 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
2445
2446 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
2447 BOOST_CHECK_EQUAL( entries[0].panelType, ALLOWED_ORIENTATION );
2448
2449 auto orientData =
2450 std::dynamic_pointer_cast<DRC_RE_ALLOWED_ORIENTATION_CONSTRAINT_DATA>( entries[0].constraintData );
2451 BOOST_REQUIRE( orientData );
2452 BOOST_CHECK( orientData->GetIsZeroDegreesAllowed() );
2453 BOOST_CHECK( orientData->GetIsNinetyDegreesAllowed() );
2454 BOOST_CHECK( !orientData->GetIsOneEightyDegreesAllowed() );
2455 BOOST_CHECK( !orientData->GetIsAllDegreesAllowed() );
2456
2457 // Single-line variant
2458 wxString singleLine = "(version 1) (rule \"SingleLine\" (constraint assertion \"A.Orientation == 0 deg || "
2459 "A.Orientation == 90 deg\"))";
2460
2461 entries = loader.LoadFromString( singleLine );
2462
2463 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
2464 BOOST_CHECK_EQUAL( entries[0].panelType, ALLOWED_ORIENTATION );
2465
2466 auto singleLineData =
2467 std::dynamic_pointer_cast<DRC_RE_ALLOWED_ORIENTATION_CONSTRAINT_DATA>( entries[0].constraintData );
2468 BOOST_REQUIRE( singleLineData );
2469 BOOST_CHECK( singleLineData->GetIsZeroDegreesAllowed() );
2470 BOOST_CHECK( singleLineData->GetIsNinetyDegreesAllowed() );
2471 BOOST_CHECK( !singleLineData->GetIsOneEightyDegreesAllowed() );
2472 BOOST_CHECK( !singleLineData->GetIsAllDegreesAllowed() );
2473}
2474
2475BOOST_AUTO_TEST_CASE( RuleLoaderAllowAllOrientationLoadsStructured )
2476{
2477 wxString ruleText = "(version 1)\n"
2478 "(rule \"AllAngles\"\n"
2479 " (constraint assertion \"A.Orientation == 0 deg || A.Orientation == 90 deg || "
2480 "A.Orientation == 180 deg || A.Orientation == 270 deg\")\n"
2481 ")";
2482
2483 DRC_RULE_LOADER loader;
2484 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
2485
2486 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
2487 BOOST_CHECK_EQUAL( entries[0].panelType, ALLOWED_ORIENTATION );
2488
2489 auto orientData =
2490 std::dynamic_pointer_cast<DRC_RE_ALLOWED_ORIENTATION_CONSTRAINT_DATA>( entries[0].constraintData );
2491 BOOST_REQUIRE( orientData );
2492 BOOST_CHECK( orientData->GetIsAllDegreesAllowed() );
2493 BOOST_CHECK( orientData->GetIsZeroDegreesAllowed() );
2494 BOOST_CHECK( orientData->GetIsNinetyDegreesAllowed() );
2495 BOOST_CHECK( orientData->GetIsOneEightyDegreesAllowed() );
2496 BOOST_CHECK( orientData->GetIsTwoSeventyDegreesAllowed() );
2497}
2498
2499BOOST_AUTO_TEST_CASE( RuleLoaderPermittedLayersInnerLayerFallsBackToCustom )
2500{
2501 wxString ruleText = "(version 1)\n"
2502 "(rule \"InnerLayers\"\n"
2503 " (constraint assertion \"A.Layer == 'F.Cu' || A.Layer == 'In1.Cu'\")\n"
2504 ")";
2505
2506 DRC_RULE_LOADER loader;
2507 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
2508
2509 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
2510 BOOST_CHECK_EQUAL( entries[0].panelType, CUSTOM_RULE );
2511
2512 auto customData = std::dynamic_pointer_cast<DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA>( entries[0].constraintData );
2513 BOOST_REQUIRE( customData );
2514 BOOST_CHECK( customData->GetRuleText().Contains( wxS( "In1.Cu" ) ) );
2515}
2516
2517BOOST_AUTO_TEST_CASE( RuleLoaderPermittedLayersStandardLoadsStructured )
2518{
2519 wxString ruleText = "(version 1)\n"
2520 "(rule \"StandardLayers\"\n"
2521 " (constraint assertion \"A.Layer == 'F.Cu' || A.Layer == 'B.Cu'\")\n"
2522 ")";
2523
2524 DRC_RULE_LOADER loader;
2525 std::vector<DRC_RE_LOADED_PANEL_ENTRY> entries = loader.LoadFromString( ruleText );
2526
2527 BOOST_REQUIRE_EQUAL( entries.size(), 1 );
2528 BOOST_CHECK_EQUAL( entries[0].panelType, PERMITTED_LAYERS );
2529
2530 auto layerData = std::dynamic_pointer_cast<DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA>( entries[0].constraintData );
2531 BOOST_REQUIRE( layerData );
2532 BOOST_CHECK( layerData->GetTopLayerEnabled() );
2533 BOOST_CHECK( layerData->GetBottomLayerEnabled() );
2534}
2535
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:373
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT, bool aSkipConnectivity=false) override
Removes an item from the container.
Definition board.cpp:1355
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition board.cpp:1158
MINOPTMAX< int > & Value()
Definition drc_rule.h:197
Design Rule Checker object that performs all the DRC tests.
Definition drc_engine.h:129
std::vector< BOARD_ITEM * > GetItemsMatchingRule(const std::shared_ptr< DRC_RULE > &aRule, REPORTER *aReporter=nullptr)
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(const wxString &aCode)
void SetRuleCondition(const 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.
std::vector< wxString > GetConstraintClauses(const RULE_GENERATION_CONTEXT &aContext) const override
Returns just the constraint clauses without the rule wrapper.
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:67
void SetReference(const wxString &aReference)
Definition footprint.h:863
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
void SetMin(T v)
Definition minoptmax.h:38
void SetOpt(T v)
Definition minoptmax.h:40
void SetMax(T v)
Definition minoptmax.h:39
wxString GetRuleName()
Get the name of the rule.
@ COURTYARD_CLEARANCE_CONSTRAINT
Definition drc_rule.h:57
@ VIA_DIAMETER_CONSTRAINT
Definition drc_rule.h:72
@ DIFF_PAIR_GAP_CONSTRAINT
Definition drc_rule.h:78
@ TRACK_WIDTH_CONSTRAINT
Definition drc_rule.h:61
@ SILK_CLEARANCE_CONSTRAINT
Definition drc_rule.h:58
@ EDGE_CLEARANCE_CONSTRAINT
Definition drc_rule.h:55
@ TEXT_THICKNESS_CONSTRAINT
Definition drc_rule.h:60
@ LENGTH_CONSTRAINT
Definition drc_rule.h:73
@ CLEARANCE_CONSTRAINT
Definition drc_rule.h:51
@ MAX_UNCOUPLED_CONSTRAINT
Definition drc_rule.h:79
@ SKEW_CONSTRAINT
Definition drc_rule.h:77
@ HOLE_CLEARANCE_CONSTRAINT
Definition drc_rule.h:53
@ HOLE_SIZE_CONSTRAINT
Definition drc_rule.h:56
@ TEXT_HEIGHT_CONSTRAINT
Definition drc_rule.h:59
@ HOLE_TO_HOLE_CONSTRAINT
Definition drc_rule.h:54
@ ALLOWED_ORIENTATION
@ SILK_TO_SILK_CLEARANCE
@ ROUTING_DIFF_PAIR
@ SILK_TO_SOLDERMASK_CLEARANCE
@ COURTYARD_CLEARANCE
@ MINIMUM_CONNECTION_WIDTH
@ ABSOLUTE_LENGTH
@ MINIMUM_CLEARANCE
@ PERMITTED_LAYERS
@ MINIMUM_TEXT_HEIGHT_AND_THICKNESS
@ COPPER_TO_HOLE_CLEARANCE
@ HOLE_TO_HOLE_DISTANCE
@ ROUTING_WIDTH
@ MATCHED_LENGTH_DIFF_PAIR
@ COPPER_TO_EDGE_CLEARANCE
@ MINIMUM_VIA_DIAMETER
@ F_SilkS
Definition layer_ids.h:96
@ B_SilkS
Definition layer_ids.h:97
@ 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
LSET layerCondition
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< wxString > 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:71
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
Definition typeinfo.h:81
@ PCB_GENERATOR_T
class PCB_GENERATOR, generator on a layer
Definition typeinfo.h:84
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition typeinfo.h:90
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
Definition typeinfo.h:104
@ PCB_ZONE_T
class ZONE, a copper pour area
Definition typeinfo.h:101
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition typeinfo.h:85
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition typeinfo.h:79
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition typeinfo.h:80
@ PCB_NETINFO_T
class NETINFO_ITEM, a description of a net
Definition typeinfo.h:103
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition typeinfo.h:89