kicad/pcbnew/drc/drc_rule_parser.cpp

676 lines
21 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2020-2022 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#include <board.h>
#include <zones.h>
#include <drc/drc_rule_parser.h>
#include <drc/drc_rule_condition.h>
#include <drc_rules_lexer.h>
#include <pcb_expr_evaluator.h>
#include <reporter.h>
using namespace DRCRULE_T;
DRC_RULES_PARSER::DRC_RULES_PARSER( const wxString& aSource, const wxString& aSourceDescr ) :
DRC_RULES_LEXER( aSource.ToStdString(), aSourceDescr ),
m_requiredVersion( 0 ),
m_tooRecent( false ),
m_reporter( nullptr )
{
}
DRC_RULES_PARSER::DRC_RULES_PARSER( FILE* aFile, const wxString& aFilename ) :
DRC_RULES_LEXER( aFile, aFilename ),
m_requiredVersion( 0 ),
m_tooRecent( false ),
m_reporter( nullptr )
{
}
void DRC_RULES_PARSER::reportError( const wxString& aMessage )
{
wxString rest;
wxString first = aMessage.BeforeFirst( '|', &rest );
if( m_reporter )
{
wxString msg = wxString::Format( _( "ERROR: <a href='%d:%d'>%s</a>%s" ), CurLineNumber(),
CurOffset(), first, rest );
m_reporter->Report( msg, RPT_SEVERITY_ERROR );
}
else
{
wxString msg = wxString::Format( _( "ERROR: %s%s" ), first, rest );
THROW_PARSE_ERROR( msg, CurSource(), CurLine(), CurLineNumber(), CurOffset() );
}
}
void DRC_RULES_PARSER::reportDeprecation( const wxString& oldToken, const wxString newToken )
{
if( m_reporter )
{
wxString msg = wxString::Format( _( "The '%s' keyword has been deprecated. "
"Please use '%s' instead." ),
oldToken,
newToken);
m_reporter->Report( msg, RPT_SEVERITY_WARNING );
}
}
void DRC_RULES_PARSER::parseUnknown()
{
int depth = 1;
for( T token = NextTok(); token != T_EOF; token = NextTok() )
{
if( token == T_LEFT )
depth++;
if( token == T_RIGHT )
{
if( --depth == 0 )
break;
}
}
}
void DRC_RULES_PARSER::Parse( std::vector<std::shared_ptr<DRC_RULE>>& aRules, REPORTER* aReporter )
{
bool haveVersion = false;
wxString msg;
m_reporter = aReporter;
for( T token = NextTok(); token != T_EOF; token = NextTok() )
{
if( token != T_LEFT )
reportError( _( "Missing '('." ) );
token = NextTok();
if( !haveVersion && token != T_version )
{
reportError( _( "Missing version statement." ) );
haveVersion = true; // don't keep on reporting it
}
switch( token )
{
case T_version:
haveVersion = true;
token = NextTok();
if( (int) token == DSN_RIGHT )
{
reportError( _( "Missing version number." ) );
break;
}
if( (int) token == DSN_NUMBER )
{
m_requiredVersion = (int)strtol( CurText(), nullptr, 10 );
m_tooRecent = ( m_requiredVersion > DRC_RULE_FILE_VERSION );
token = NextTok();
}
else
{
msg.Printf( _( "Unrecognized item '%s'.| Expected version number." ),
FromUTF8() );
reportError( msg );
}
if( (int) token != DSN_RIGHT )
{
msg.Printf( _( "Unrecognized item '%s'." ),
FromUTF8() );
reportError( msg );
parseUnknown();
}
break;
case T_rule:
aRules.emplace_back( parseDRC_RULE() );
break;
case T_EOF:
reportError( _( "Incomplete statement." ) );
break;
default:
msg.Printf( _( "Unrecognized item '%s'.| Expected %s." ), FromUTF8(),
wxT( "rule or version" ) );
reportError( msg );
parseUnknown();
}
}
if( m_reporter && !m_reporter->HasMessage() )
m_reporter->Report( _( "No errors found." ), RPT_SEVERITY_INFO );
m_reporter = nullptr;
}
std::shared_ptr<DRC_RULE> DRC_RULES_PARSER::parseDRC_RULE()
{
std::shared_ptr<DRC_RULE> rule = std::make_shared<DRC_RULE>();
T token = NextTok();
wxString msg;
if( !IsSymbol( token ) )
reportError( _( "Missing rule name." ) );
rule->m_Name = FromUTF8();
for( token = NextTok(); token != T_RIGHT && token != T_EOF; token = NextTok() )
{
if( token != T_LEFT )
reportError( _( "Missing '('." ) );
token = NextTok();
switch( token )
{
case T_constraint:
parseConstraint( rule.get() );
break;
case T_condition:
token = NextTok();
if( (int) token == DSN_RIGHT )
{
reportError( _( "Missing condition expression." ) );
break;
}
if( IsSymbol( token ) )
{
rule->m_Condition = new DRC_RULE_CONDITION( FromUTF8() );
rule->m_Condition->Compile( m_reporter, CurLineNumber(), CurOffset() );
}
else
{
msg.Printf( _( "Unrecognized item '%s'.| Expected quoted expression." ),
FromUTF8() );
reportError( msg );
}
if( (int) NextTok() != DSN_RIGHT )
{
reportError( wxString::Format( _( "Unrecognized item '%s'." ), FromUTF8() ) );
parseUnknown();
}
break;
case T_layer:
rule->m_LayerSource = FromUTF8();
rule->m_LayerCondition = parseLayer();
break;
case T_severity:
rule->m_Severity = parseSeverity();
break;
case T_EOF:
reportError( _( "Incomplete statement." ) );
return rule;
default:
msg.Printf( _( "Unrecognized item '%s'.| Expected %s." ), FromUTF8(),
wxT( "constraint, condition, or disallow" ) );
reportError( msg );
parseUnknown();
}
}
if( (int) CurTok() != DSN_RIGHT )
reportError( _( "Missing ')'." ) );
return rule;
}
void DRC_RULES_PARSER::parseConstraint( DRC_RULE* aRule )
{
DRC_CONSTRAINT c;
int value;
wxString msg;
T token = NextTok();
if( token == T_mechanical_clearance )
{
reportDeprecation( wxT( "mechanical_clearance" ), wxT( "physical_clearance" ) );
token = T_physical_clearance;
}
else if( token == T_mechanical_hole_clearance )
{
reportDeprecation( wxT( "mechanical_hole_clearance" ), wxT( "physical_hole_clearance" ) );
token = T_physical_hole_clearance;
}
else if( token == T_hole )
{
reportDeprecation( wxT( "hole" ), wxT( "hole_size" ) );
token = T_hole_size;
}
else if( (int) token == DSN_RIGHT || token == T_EOF )
{
msg.Printf( _( "Missing constraint type.| Expected %s." ),
wxT( "assertion, clearance, hole_clearance, edge_clearance, "
"physical_clearance, physical_hole_clearance, courtyard_clearance, "
"silk_clearance, hole_size, hole_to_hole, track_width, annular_width, "
"via_diameter, disallow, zone_connection, thermal_relief_gap, "
"thermal_spoke_width, min_resolved_spokes, length, skew, via_count, "
"diff_pair_gap or diff_pair_uncoupled" ) );
reportError( msg );
return;
}
switch( token )
{
case T_assertion: c.m_Type = ASSERTION_CONSTRAINT; break;
case T_clearance: c.m_Type = CLEARANCE_CONSTRAINT; break;
case T_hole_clearance: c.m_Type = HOLE_CLEARANCE_CONSTRAINT; break;
case T_edge_clearance: c.m_Type = EDGE_CLEARANCE_CONSTRAINT; break;
case T_hole_size: c.m_Type = HOLE_SIZE_CONSTRAINT; break;
case T_hole_to_hole: c.m_Type = HOLE_TO_HOLE_CONSTRAINT; break;
case T_courtyard_clearance: c.m_Type = COURTYARD_CLEARANCE_CONSTRAINT; break;
case T_silk_clearance: c.m_Type = SILK_CLEARANCE_CONSTRAINT; break;
case T_text_height: c.m_Type = TEXT_HEIGHT_CONSTRAINT; break;
case T_text_thickness: c.m_Type = TEXT_THICKNESS_CONSTRAINT; break;
case T_track_width: c.m_Type = TRACK_WIDTH_CONSTRAINT; break;
case T_connection_width: c.m_Type = CONNECTION_WIDTH_CONSTRAINT; break;
case T_annular_width: c.m_Type = ANNULAR_WIDTH_CONSTRAINT; break;
case T_via_diameter: c.m_Type = VIA_DIAMETER_CONSTRAINT; break;
case T_zone_connection: c.m_Type = ZONE_CONNECTION_CONSTRAINT; break;
case T_thermal_relief_gap: c.m_Type = THERMAL_RELIEF_GAP_CONSTRAINT; break;
case T_thermal_spoke_width: c.m_Type = THERMAL_SPOKE_WIDTH_CONSTRAINT; break;
case T_min_resolved_spokes: c.m_Type = MIN_RESOLVED_SPOKES_CONSTRAINT; break;
case T_disallow: c.m_Type = DISALLOW_CONSTRAINT; break;
case T_length: c.m_Type = LENGTH_CONSTRAINT; break;
case T_skew: c.m_Type = SKEW_CONSTRAINT; break;
case T_via_count: c.m_Type = VIA_COUNT_CONSTRAINT; break;
case T_diff_pair_gap: c.m_Type = DIFF_PAIR_GAP_CONSTRAINT; break;
case T_diff_pair_uncoupled: c.m_Type = DIFF_PAIR_MAX_UNCOUPLED_CONSTRAINT; break;
case T_physical_clearance: c.m_Type = PHYSICAL_CLEARANCE_CONSTRAINT; break;
case T_physical_hole_clearance: c.m_Type = PHYSICAL_HOLE_CLEARANCE_CONSTRAINT; break;
default:
msg.Printf( _( "Unrecognized item '%s'.| Expected %s." ), FromUTF8(),
wxT( "assertion, clearance, hole_clearance, edge_clearance, "
"physical_clearance, physical_hole_clearance, courtyard_clearance, "
"silk_clearance, hole_size, hole_to_hole, track_width, annular_width, "
"disallow, zone_connection, thermal_relief_gap, thermal_spoke_width, "
"min_resolved_spokes, length, skew, via_count, via_diameter, "
"diff_pair_gap or diff_pair_uncoupled" ) );
reportError( msg );
}
if( aRule->FindConstraint( c.m_Type ) )
{
msg.Printf( _( "Rule already has a '%s' constraint." ), FromUTF8() );
reportError( msg );
}
if( c.m_Type == DISALLOW_CONSTRAINT )
{
for( token = NextTok(); token != T_RIGHT; token = NextTok() )
{
if( (int) token == DSN_STRING )
token = GetCurStrAsToken();
switch( token )
{
case T_track: c.m_DisallowFlags |= DRC_DISALLOW_TRACKS; break;
case T_via: c.m_DisallowFlags |= DRC_DISALLOW_VIAS; break;
case T_micro_via: c.m_DisallowFlags |= DRC_DISALLOW_MICRO_VIAS; break;
case T_buried_via: c.m_DisallowFlags |= DRC_DISALLOW_BB_VIAS; break;
case T_pad: c.m_DisallowFlags |= DRC_DISALLOW_PADS; break;
case T_zone: c.m_DisallowFlags |= DRC_DISALLOW_ZONES; break;
case T_text: c.m_DisallowFlags |= DRC_DISALLOW_TEXTS; break;
case T_graphic: c.m_DisallowFlags |= DRC_DISALLOW_GRAPHICS; break;
case T_hole: c.m_DisallowFlags |= DRC_DISALLOW_HOLES; break;
case T_footprint: c.m_DisallowFlags |= DRC_DISALLOW_FOOTPRINTS; break;
case T_EOF:
reportError( _( "Missing ')'." ) );
return;
default:
msg.Printf( _( "Unrecognized item '%s'.| Expected %s." ), FromUTF8(),
wxT( "track, via, micro_via, buried_via, pad, zone, text, graphic, "
"hole, or footprint." ) );
reportError( msg );
break;
}
}
if( (int) CurTok() != DSN_RIGHT )
reportError( _( "Missing ')'." ) );
aRule->AddConstraint( c );
return;
}
else if( c.m_Type == ZONE_CONNECTION_CONSTRAINT )
{
token = NextTok();
if( (int) token == DSN_STRING )
token = GetCurStrAsToken();
switch( token )
{
case T_solid: c.m_ZoneConnection = ZONE_CONNECTION::FULL; break;
case T_thermal_reliefs: c.m_ZoneConnection = ZONE_CONNECTION::THERMAL; break;
case T_none: c.m_ZoneConnection = ZONE_CONNECTION::NONE; break;
case T_EOF:
reportError( _( "Missing ')'." ) );
return;
default:
msg.Printf( _( "Unrecognized item '%s'.| Expected %s." ), FromUTF8(),
"solid, thermal_reliefs or none." );
reportError( msg );
break;
}
if( (int) NextTok() != DSN_RIGHT )
reportError( _( "Missing ')'." ) );
aRule->AddConstraint( c );
return;
}
else if( c.m_Type == MIN_RESOLVED_SPOKES_CONSTRAINT )
{
// We don't use a min/max/opt structure here for two reasons:
//
// 1) The min/max/opt parser can't handle unitless numbers, and if we make it handle
// them then it will no longer catch the more common case of forgetting to add a unit
// and getting an ineffective rule because the distances are in nanometers.
//
// 2) Min/max/opt gives a strong implication that you could specify the optimal number
// of spokes. We don't want to open that door because the spoke generator is highly
// optimized around being able to "cheat" off of a cartesian coordinate system.
token = NextTok();
if( (int) token == DSN_NUMBER )
{
value = (int) strtol( CurText(), nullptr, 10 );
c.m_Value.SetMin( value );
}
else
{
reportError( _( "Expecting number." ) );
parseUnknown();
}
if( (int) NextTok() != DSN_RIGHT )
reportError( _( "Missing ')'." ) );
aRule->AddConstraint( c );
return;
}
else if( c.m_Type == ASSERTION_CONSTRAINT )
{
token = NextTok();
if( (int) token == DSN_RIGHT )
reportError( _( "Missing assertion expression." ) );
if( IsSymbol( token ) )
{
c.m_Test = new DRC_RULE_CONDITION( FromUTF8() );
c.m_Test->Compile( m_reporter, CurLineNumber(), CurOffset() );
}
else
{
msg.Printf( _( "Unrecognized item '%s'.| Expected quoted expression." ), FromUTF8() );
reportError( msg );
}
if( (int) NextTok() != DSN_RIGHT )
{
reportError( wxString::Format( _( "Unrecognized item '%s'." ), FromUTF8() ) );
parseUnknown();
}
aRule->AddConstraint( c );
return;
}
for( token = NextTok(); token != T_RIGHT && token != T_EOF; token = NextTok() )
{
if( token != T_LEFT )
reportError( _( "Missing '('." ) );
token = NextTok();
switch( token )
{
case T_min:
token = NextTok();
if( (int) token == DSN_RIGHT )
{
reportError( _( "Missing min value." ) );
break;
}
parseValueWithUnits( FromUTF8(), value );
c.m_Value.SetMin( value );
if( (int) NextTok() != DSN_RIGHT )
{
reportError( wxString::Format( _( "Unrecognized item '%s'." ), FromUTF8() ) );
parseUnknown();
}
break;
case T_max:
token = NextTok();
if( (int) token == DSN_RIGHT )
{
reportError( _( "Missing max value." ) );
break;
}
parseValueWithUnits( FromUTF8(), value );
c.m_Value.SetMax( value );
if( (int) NextTok() != DSN_RIGHT )
{
reportError( wxString::Format( _( "Unrecognized item '%s'." ), FromUTF8() ) );
parseUnknown();
}
break;
case T_opt:
token = NextTok();
if( (int) token == DSN_RIGHT )
{
reportError( _( "Missing opt value." ) );
break;
}
parseValueWithUnits( FromUTF8(), value );
c.m_Value.SetOpt( value );
if( (int) NextTok() != DSN_RIGHT )
{
reportError( wxString::Format( _( "Unrecognized item '%s'." ), FromUTF8() ) );
parseUnknown();
}
break;
case T_EOF:
reportError( _( "Incomplete statement." ) );
return;
default:
msg.Printf( _( "Unrecognized item '%s'.| Expected %s." ),
FromUTF8(),
wxT( "min, max, or opt" ) );
reportError( msg );
parseUnknown();
}
}
if( (int) CurTok() != DSN_RIGHT )
reportError( _( "Missing ')'." ) );
aRule->AddConstraint( c );
}
void DRC_RULES_PARSER::parseValueWithUnits( const wxString& aExpr, int& aResult )
{
auto errorHandler = [&]( const wxString& aMessage, int aOffset )
{
wxString rest;
wxString first = aMessage.BeforeFirst( '|', &rest );
if( m_reporter )
{
wxString msg = wxString::Format( _( "ERROR: <a href='%d:%d'>%s</a>%s" ),
CurLineNumber(), CurOffset() + aOffset, first, rest );
m_reporter->Report( msg, RPT_SEVERITY_ERROR );
}
else
{
wxString msg = wxString::Format( _( "ERROR: %s%s" ), first, rest );
THROW_PARSE_ERROR( msg, CurSource(), CurLine(), CurLineNumber(),
CurOffset() + aOffset );
}
};
PCB_EXPR_EVALUATOR evaluator;
evaluator.SetErrorCallback( errorHandler );
evaluator.Evaluate( aExpr );
aResult = evaluator.Result();
}
LSET DRC_RULES_PARSER::parseLayer()
{
LSET retVal;
int token = NextTok();
if( (int) token == DSN_RIGHT )
{
reportError( _( "Missing layer name or type." ) );
return LSET::AllCuMask();
}
else if( token == T_outer )
{
retVal = LSET::ExternalCuMask();
}
else if( token == T_inner )
{
retVal = LSET::InternalCuMask();
}
else
{
wxString layerName = FromUTF8();
wxPGChoices& layerMap = ENUM_MAP<PCB_LAYER_ID>::Instance().Choices();
for( unsigned ii = 0; ii < layerMap.GetCount(); ++ii )
{
wxPGChoiceEntry& entry = layerMap[ii];
if( entry.GetText().Matches( layerName ) )
retVal.set( ToLAYER_ID( entry.GetValue() ) );
}
if( !retVal.any() )
{
reportError( wxString::Format( _( "Unrecognized layer '%s'." ), layerName ) );
retVal.set( Rescue );
}
}
if( (int) NextTok() != DSN_RIGHT )
{
reportError( wxString::Format( _( "Unrecognized item '%s'." ), FromUTF8() ) );
parseUnknown();
}
return retVal;
}
SEVERITY DRC_RULES_PARSER::parseSeverity()
{
SEVERITY retVal = RPT_SEVERITY_UNDEFINED;
wxString msg;
T token = NextTok();
if( (int) token == DSN_RIGHT || token == T_EOF )
{
reportError( _( "Missing severity name." ) );
return RPT_SEVERITY_UNDEFINED;
}
switch( token )
{
case T_ignore: retVal = RPT_SEVERITY_IGNORE; break;
case T_warning: retVal = RPT_SEVERITY_WARNING; break;
case T_error: retVal = RPT_SEVERITY_ERROR; break;
case T_exclusion: retVal = RPT_SEVERITY_EXCLUSION; break;
default:
msg.Printf( _( "Unrecognized item '%s'.| Expected %s." ),
FromUTF8(),
wxT( "ignore, warning, error, or exclusion" ) );
reportError( msg );
parseUnknown();
}
if( (int) NextTok() != DSN_RIGHT )
reportError( _( "Missing ')'." ) );
return retVal;
}