148 *aErrorText = wxEmptyString;
151 [&](
const wxString& aMessage ) -> wxString
154 *aErrorText = aMessage;
156 return wxEmptyString;
159 auto escapeQuotedRuleText =
160 [](
const wxString& aText ) -> wxString
162 wxString escaped = aText;
163 escaped.Replace(
"\\",
"\\\\" );
164 escaped.Replace(
"\"",
"\\\"" );
168 auto hasConstraintOption =
169 [](
const kiapi::board::CustomRuleConstraint& aConstraint,
170 const kiapi::board::CustomRuleConstraintOption aOption ) ->
bool
172 for(
int optionValue : aConstraint.options() )
174 if(
static_cast<kiapi::board::CustomRuleConstraintOption
>( optionValue ) == aOption )
181 auto getConstraintToken =
182 [](
const kiapi::board::CustomRuleConstraintType aType,
183 bool* aAddWithinDiffPairs ) -> std::optional<wxString>
185 if( aAddWithinDiffPairs )
186 *aAddWithinDiffPairs =
false;
190 case kiapi::board::CRCT_CLEARANCE:
return wxS(
"clearance" );
191 case kiapi::board::CRCT_CREEPAGE:
return wxS(
"creepage" );
192 case kiapi::board::CRCT_HOLE_CLEARANCE:
return wxS(
"hole_clearance" );
193 case kiapi::board::CRCT_HOLE_TO_HOLE:
return wxS(
"hole_to_hole" );
194 case kiapi::board::CRCT_EDGE_CLEARANCE:
return wxS(
"edge_clearance" );
195 case kiapi::board::CRCT_HOLE_SIZE:
return wxS(
"hole_size" );
196 case kiapi::board::CRCT_COURTYARD_CLEARANCE:
return wxS(
"courtyard_clearance" );
197 case kiapi::board::CRCT_SILK_CLEARANCE:
return wxS(
"silk_clearance" );
198 case kiapi::board::CRCT_TEXT_HEIGHT:
return wxS(
"text_height" );
199 case kiapi::board::CRCT_LINE_WIDTH:
return wxS(
"line_width" );
200 case kiapi::board::CRCT_TRACK_WIDTH:
return wxS(
"track_width" );
201 case kiapi::board::CRCT_TRACK_SEGMENT_LENGTH:
return wxS(
"track_segment_length" );
202 case kiapi::board::CRCT_ANNULAR_WIDTH:
return wxS(
"annular_width" );
203 case kiapi::board::CRCT_ZONE_CONNECTION:
return wxS(
"zone_connection" );
204 case kiapi::board::CRCT_THERMAL_RELIEF_GAP:
return wxS(
"thermal_relief_gap" );
205 case kiapi::board::CRCT_THERMAL_SPOKE_WIDTH:
return wxS(
"thermal_spoke_width" );
206 case kiapi::board::CRCT_MIN_RESOLVED_SPOKES:
return wxS(
"min_resolved_spokes" );
207 case kiapi::board::CRCT_SOLDER_MASK_EXPANSION:
return wxS(
"solder_mask_expansion" );
208 case kiapi::board::CRCT_SOLDER_PASTE_ABS_MARGIN:
return wxS(
"solder_paste_abs_margin" );
209 case kiapi::board::CRCT_SOLDER_PASTE_REL_MARGIN:
return wxS(
"solder_paste_rel_margin" );
210 case kiapi::board::CRCT_DISALLOW:
return wxS(
"disallow" );
211 case kiapi::board::CRCT_VIA_DIAMETER:
return wxS(
"via_diameter" );
212 case kiapi::board::CRCT_LENGTH:
return wxS(
"length" );
213 case kiapi::board::CRCT_SKEW:
return wxS(
"skew" );
214 case kiapi::board::CRCT_DIFF_PAIR_GAP:
return wxS(
"diff_pair_gap" );
215 case kiapi::board::CRCT_MAX_UNCOUPLED:
return wxS(
"diff_pair_uncoupled" );
216 case kiapi::board::CRCT_DIFF_PAIR_INTRA_SKEW:
218 if( aAddWithinDiffPairs )
219 *aAddWithinDiffPairs =
true;
221 return wxS(
"skew" );
223 case kiapi::board::CRCT_VIA_COUNT:
return wxS(
"via_count" );
224 case kiapi::board::CRCT_PHYSICAL_CLEARANCE:
return wxS(
"physical_clearance" );
225 case kiapi::board::CRCT_PHYSICAL_HOLE_CLEARANCE:
return wxS(
"physical_hole_clearance" );
226 case kiapi::board::CRCT_ASSERTION:
return wxS(
"assertion" );
227 case kiapi::board::CRCT_CONNECTION_WIDTH:
return wxS(
"connection_width" );
228 case kiapi::board::CRCT_TRACK_ANGLE:
return wxS(
"track_angle" );
229 case kiapi::board::CRCT_VIA_DANGLING:
return wxS(
"via_dangling" );
230 case kiapi::board::CRCT_BRIDGED_MASK:
return wxS(
"bridged_mask" );
231 case kiapi::board::CRCT_SOLDER_MASK_SLIVER:
return wxS(
"solder_mask_sliver" );
232 case kiapi::board::CRCT_NET_CHAIN_LENGTH:
return wxS(
"net_chain_length" );
233 case kiapi::board::CRCT_NET_CHAIN_STUB_LENGTH:
return wxS(
"stub_length" );
234 case kiapi::board::CRCT_NET_CHAIN_RETURN_PATH:
return wxS(
"return_path" );
235 case kiapi::board::CRCT_MICROVIA_STACK_DEPTH:
return wxS(
"microvia_stack_depth" );
236 case kiapi::board::CRCT_HOLE_ASPECT_RATIO:
return wxS(
"hole_aspect_ratio" );
238 case kiapi::board::CRCT_UNKNOWN:
244 auto formatNumericValueForConstraint =
245 [&](
const kiapi::board::CustomRuleConstraint& aConstraint,
246 const int aValue ) -> wxString
248 if( aConstraint.type() == kiapi::board::CRCT_TRACK_ANGLE )
249 return wxString::Format(
"%ddeg", aValue );
251 if( aConstraint.type() == kiapi::board::CRCT_HOLE_ASPECT_RATIO )
254 switch( aConstraint.type() )
256 case kiapi::board::CRCT_VIA_COUNT:
257 case kiapi::board::CRCT_MIN_RESOLVED_SPOKES:
258 case kiapi::board::CRCT_VIA_DANGLING:
259 case kiapi::board::CRCT_BRIDGED_MASK:
260 case kiapi::board::CRCT_MICROVIA_STACK_DEPTH:
261 return wxString::Format(
"%d", aValue );
267 if( hasConstraintOption( aConstraint, kiapi::board::CRCO_TIME_DOMAIN ) )
269 double picoseconds = aValue /
pcbIUScale.IU_PER_PS;
278 [](
const kiapi::common::types::RuleSeverity aSeverity ) -> wxString
282 case kiapi::common::types::RuleSeverity::RS_WARNING:
return wxS(
"warning" );
283 case kiapi::common::types::RuleSeverity::RS_ERROR:
return wxS(
"error" );
284 case kiapi::common::types::RuleSeverity::RS_EXCLUSION:
return wxS(
"exclusion" );
285 case kiapi::common::types::RuleSeverity::RS_IGNORE:
return wxS(
"ignore" );
288 return wxEmptyString;
292 if( aRule.name().empty() )
293 return fail( wxS(
"Rules must have a name" ) );
296 ruleText <<
"(rule \"" << escapeQuotedRuleText( wxString::FromUTF8( aRule.name() ) ) <<
"\"\n";
298 if( aRule.has_comments() && !aRule.comments().empty() )
300 wxArrayString commentLines = wxSplit( wxString::FromUTF8( aRule.comments() ),
'\n',
'\0' );
302 for(
const wxString& line : commentLines )
303 ruleText <<
"\t# " << line <<
"\n";
306 if( !aRule.condition().empty() )
308 ruleText <<
"\t(condition \""
309 << escapeQuotedRuleText( wxString::FromUTF8( aRule.condition() ) )
313 if( aRule.layer_condition_case() == kiapi::board::CustomRule::LayerConditionCase::kLayerMode )
315 switch( aRule.layer_mode() )
317 case kiapi::board::CRLM_OUTER:
318 ruleText <<
"\t(layer outer)\n";
321 case kiapi::board::CRLM_INNER:
322 ruleText <<
"\t(layer inner)\n";
325 case kiapi::board::CRLM_UNKNOWN:
330 else if( aRule.layer_condition_case() == kiapi::board::CustomRule::LayerConditionCase::kSingleLayer )
336 return fail( wxS(
"Invalid single_layer value in custom rule" ) );
341 for(
const kiapi::board::CustomRuleConstraint& constraint : aRule.constraints() )
343 bool addWithinDiffPairs =
false;
344 std::optional<wxString> token = getConstraintToken( constraint.type(), &addWithinDiffPairs );
347 return fail( wxS(
"Unsupported custom rule constraint type" ) );
349 wxString
text = wxS(
"\t(constraint " ) + *token;
351 if( constraint.has_name() && !constraint.name().empty() )
353 text += wxS(
" (name \"" )
354 + escapeQuotedRuleText( wxString::FromUTF8( constraint.name() ) )
360 if( constraint.type() == kiapi::board::CRCT_MIN_RESOLVED_SPOKES )
362 text += wxString::Format(
"%d", constraint.numeric().min() );
364 else if( constraint.value_case() == kiapi::board::CustomRuleConstraint::ValueCase::kDisallow )
366 for(
int disallowTypeValue : constraint.disallow().types() )
368 kiapi::board::CustomRuleDisallowType disallowType =
369 static_cast<kiapi::board::CustomRuleDisallowType
>( disallowTypeValue );
371 switch( disallowType )
373 case kiapi::board::CRDT_THROUGH_VIAS:
text += wxS(
" through_via" );
break;
374 case kiapi::board::CRDT_MICRO_VIAS:
text += wxS(
" micro_via" );
break;
375 case kiapi::board::CRDT_BLIND_VIAS:
text += wxS(
" blind_via" );
break;
376 case kiapi::board::CRDT_BURIED_VIAS:
text += wxS(
" buried_via" );
break;
377 case kiapi::board::CRDT_TRACKS:
text += wxS(
" track" );
break;
378 case kiapi::board::CRDT_PADS:
text += wxS(
" pad" );
break;
379 case kiapi::board::CRDT_ZONES:
text += wxS(
" zone" );
break;
380 case kiapi::board::CRDT_TEXTS:
text += wxS(
" text" );
break;
381 case kiapi::board::CRDT_GRAPHICS:
text += wxS(
" graphic" );
break;
382 case kiapi::board::CRDT_HOLES:
text += wxS(
" hole" );
break;
383 case kiapi::board::CRDT_FOOTPRINTS:
text += wxS(
" footprint" );
break;
385 case kiapi::board::CRDT_UNKNOWN:
391 else if( constraint.value_case() == kiapi::board::CustomRuleConstraint::ValueCase::kZoneConnection )
393 switch( constraint.zone_connection() )
395 case kiapi::board::types::ZCS_FULL:
396 text += wxS(
" solid" );
399 case kiapi::board::types::ZCS_THERMAL:
400 text += wxS(
" thermal_reliefs" );
403 case kiapi::board::types::ZCS_NONE:
404 text += wxS(
" none" );
408 return fail( wxS(
"Unsupported zone connection style" ) );
411 else if( constraint.value_case() == kiapi::board::CustomRuleConstraint::ValueCase::kAssertionExpression )
414 + escapeQuotedRuleText( wxString::FromUTF8( constraint.assertion_expression() ) )
417 else if( constraint.value_case() == kiapi::board::CustomRuleConstraint::ValueCase::kReturnPath )
419 const kiapi::board::CustomRuleReturnPathSettings& returnPath = constraint.return_path();
421 if( !returnPath.reference_layer().empty() )
423 text += wxS(
" (layer \"" )
424 + escapeQuotedRuleText( wxString::FromUTF8( returnPath.reference_layer() ) )
428 if( !returnPath.reference_net().empty() )
430 text += wxS(
" (net \"" )
431 + escapeQuotedRuleText( wxString::FromUTF8( returnPath.reference_net() ) )
435 else if( constraint.value_case() == kiapi::board::CustomRuleConstraint::ValueCase::kNumeric )
437 const kiapi::common::types::MinOptMax& numeric = constraint.numeric();
439 if( numeric.has_min() )
440 text += wxS(
" (min " )
441 + formatNumericValueForConstraint( constraint, numeric.min() )
444 if( numeric.has_opt() )
445 text += wxS(
" (opt " )
446 + formatNumericValueForConstraint( constraint, numeric.opt() )
449 if( numeric.has_max() )
450 text += wxS(
" (max " )
451 + formatNumericValueForConstraint( constraint, numeric.max() )
455 if( addWithinDiffPairs
456 || hasConstraintOption( constraint, kiapi::board::CRCO_SKEW_WITHIN_DIFF_PAIRS ) )
458 text += wxS(
" (within_diff_pairs)" );
462 ruleText <<
text <<
"\n";
465 wxString severity = severityToken( aRule.severity() );
467 if( !severity.IsEmpty() )
468 ruleText <<
"\t(severity " << severity <<
")\n";