KiCad PCB EDA Suite
drc_rule_parser.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) 2020-2022 KiCad Developers, see change_log.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 
25 #include <board.h>
26 #include <drc/drc_rule_parser.h>
27 #include <drc/drc_rule_condition.h>
28 #include <drc_rules_lexer.h>
29 #include <pcb_expr_evaluator.h>
30 #include <reporter.h>
31 
32 using namespace DRCRULE_T;
33 
34 
35 DRC_RULES_PARSER::DRC_RULES_PARSER( const wxString& aSource, const wxString& aSourceDescr ) :
36  DRC_RULES_LEXER( aSource.ToStdString(), aSourceDescr ),
37  m_requiredVersion( 0 ),
38  m_tooRecent( false ),
39  m_reporter( nullptr )
40 {
41 }
42 
43 
44 DRC_RULES_PARSER::DRC_RULES_PARSER( FILE* aFile, const wxString& aFilename ) :
45  DRC_RULES_LEXER( aFile, aFilename ),
46  m_requiredVersion( 0 ),
47  m_tooRecent( false ),
48  m_reporter( nullptr )
49 {
50 }
51 
52 
53 void DRC_RULES_PARSER::reportError( const wxString& aMessage )
54 {
55  wxString rest;
56  wxString first = aMessage.BeforeFirst( '|', &rest );
57 
58  if( m_reporter )
59  {
60  wxString msg = wxString::Format( _( "ERROR: <a href='%d:%d'>%s</a>%s" ), CurLineNumber(),
61  CurOffset(), first, rest );
62 
64  }
65  else
66  {
67  wxString msg = wxString::Format( _( "ERROR: %s%s" ), first, rest );
68 
69  THROW_PARSE_ERROR( msg, CurSource(), CurLine(), CurLineNumber(), CurOffset() );
70  }
71 }
72 
73 
75 {
76  int depth = 1;
77 
78  for( T token = NextTok(); token != T_EOF; token = NextTok() )
79  {
80  if( token == T_LEFT )
81  depth++;
82 
83  if( token == T_RIGHT )
84  {
85  if( --depth == 0 )
86  break;
87  }
88  }
89 }
90 
91 
92 void DRC_RULES_PARSER::Parse( std::vector<DRC_RULE*>& aRules, REPORTER* aReporter )
93 {
94  bool haveVersion = false;
95  wxString msg;
96 
97  m_reporter = aReporter;
98 
99  for( T token = NextTok(); token != T_EOF; token = NextTok() )
100  {
101  if( token != T_LEFT )
102  reportError( _( "Missing '('." ) );
103 
104  token = NextTok();
105 
106  if( !haveVersion && token != T_version )
107  {
108  reportError( _( "Missing version statement." ) );
109  haveVersion = true; // don't keep on reporting it
110  }
111 
112  switch( token )
113  {
114  case T_version:
115  haveVersion = true;
116  token = NextTok();
117 
118  if( (int) token == DSN_RIGHT )
119  {
120  reportError( _( "Missing version number." ) );
121  break;
122  }
123 
124  if( (int) token == DSN_NUMBER )
125  {
126  m_requiredVersion = (int)strtol( CurText(), nullptr, 10 );
128  token = NextTok();
129  }
130  else
131  {
132  msg.Printf( _( "Unrecognized item '%s'.| Expected version number." ),
133  FromUTF8() );
134  reportError( msg );
135  }
136 
137  if( (int) token != DSN_RIGHT )
138  {
139  msg.Printf( _( "Unrecognized item '%s'." ),
140  FromUTF8() );
141  reportError( msg );
142  parseUnknown();
143  }
144 
145  break;
146 
147  case T_rule:
148  aRules.push_back( parseDRC_RULE() );
149  break;
150 
151  case T_EOF:
152  reportError( _( "Incomplete statement." ) );
153  break;
154 
155  default:
156  msg.Printf( _( "Unrecognized item '%s'.| Expected %s." ), FromUTF8(),
157  wxT( "rule or version" ) );
158  reportError( msg );
159  parseUnknown();
160  }
161  }
162 
163  if( m_reporter && !m_reporter->HasMessage() )
164  m_reporter->Report( _( "No errors found." ), RPT_SEVERITY_INFO );
165 
166  m_reporter = nullptr;
167 }
168 
169 
171 {
172  DRC_RULE* rule = new DRC_RULE();
173  T token = NextTok();
174  wxString msg;
175 
176  if( !IsSymbol( token ) )
177  reportError( _( "Missing rule name." ) );
178 
179  rule->m_Name = FromUTF8();
180 
181  for( token = NextTok(); token != T_RIGHT && token != T_EOF; token = NextTok() )
182  {
183  if( token != T_LEFT )
184  reportError( _( "Missing '('." ) );
185 
186  token = NextTok();
187 
188  switch( token )
189  {
190  case T_constraint:
191  parseConstraint( rule );
192  break;
193 
194  case T_condition:
195  token = NextTok();
196 
197  if( (int) token == DSN_RIGHT )
198  {
199  reportError( _( "Missing condition expression." ) );
200  break;
201  }
202 
203  if( IsSymbol( token ) )
204  {
205  rule->m_Condition = new DRC_RULE_CONDITION( FromUTF8() );
206  rule->m_Condition->Compile( m_reporter, CurLineNumber(), CurOffset() );
207  }
208  else
209  {
210  msg.Printf( _( "Unrecognized item '%s'.| Expected quoted expression." ),
211  FromUTF8() );
212  reportError( msg );
213  }
214 
215  if( (int) NextTok() != DSN_RIGHT )
216  {
217  reportError( wxString::Format( _( "Unrecognized item '%s'." ), FromUTF8() ) );
218  parseUnknown();
219  }
220 
221  break;
222 
223  case T_layer:
224  rule->m_LayerSource = FromUTF8();
225  rule->m_LayerCondition = parseLayer();
226  break;
227 
228  case T_EOF:
229  reportError( _( "Incomplete statement." ) );
230  return rule;
231 
232  default:
233  msg.Printf( _( "Unrecognized item '%s'.| Expected %s." ), FromUTF8(),
234  wxT( "constraint, condition, or disallow" ) );
235  reportError( msg );
236  parseUnknown();
237  }
238  }
239 
240  if( (int) CurTok() != DSN_RIGHT )
241  reportError( _( "Missing ')'." ) );
242 
243  return rule;
244 }
245 
246 
248 {
249  DRC_CONSTRAINT c;
250  int value;
251  wxString msg;
252 
253  T token = NextTok();
254 
255  if( (int) token == DSN_RIGHT || token == T_EOF )
256  {
257  msg.Printf( _( "Missing constraint type.| Expected %s." ),
258  wxT( "clearance, hole_clearance, edge_clearance, hole, hole_to_hole, "
259  "courtyard_clearance, silk_clearance, track_width, annular_width, "
260  "via_diameter, disallow, length, skew, via_count, diff_pair_gap, or "
261  "diff_pair_uncoupled" ) );
262  reportError( msg );
263  return;
264  }
265 
266  switch( token )
267  {
268  case T_clearance: c.m_Type = CLEARANCE_CONSTRAINT; break;
269  case T_hole_clearance: c.m_Type = HOLE_CLEARANCE_CONSTRAINT; break;
270  case T_edge_clearance: c.m_Type = EDGE_CLEARANCE_CONSTRAINT; break;
271  case T_hole: // legacy token
272  case T_hole_size: c.m_Type = HOLE_SIZE_CONSTRAINT; break;
273  case T_hole_to_hole: c.m_Type = HOLE_TO_HOLE_CONSTRAINT; break;
274  case T_courtyard_clearance: c.m_Type = COURTYARD_CLEARANCE_CONSTRAINT; break;
275  case T_silk_clearance: c.m_Type = SILK_CLEARANCE_CONSTRAINT; break;
276  case T_track_width: c.m_Type = TRACK_WIDTH_CONSTRAINT; break;
277  case T_annular_width: c.m_Type = ANNULAR_WIDTH_CONSTRAINT; break;
278  case T_via_diameter: c.m_Type = VIA_DIAMETER_CONSTRAINT; break;
279  case T_disallow: c.m_Type = DISALLOW_CONSTRAINT; break;
280  case T_length: c.m_Type = LENGTH_CONSTRAINT; break;
281  case T_skew: c.m_Type = SKEW_CONSTRAINT; break;
282  case T_via_count: c.m_Type = VIA_COUNT_CONSTRAINT; break;
283  case T_diff_pair_gap: c.m_Type = DIFF_PAIR_GAP_CONSTRAINT; break;
284  case T_diff_pair_uncoupled: c.m_Type = DIFF_PAIR_MAX_UNCOUPLED_CONSTRAINT; break;
285  default:
286  msg.Printf( _( "Unrecognized item '%s'.| Expected %s." ), FromUTF8(),
287  wxT( "clearance, hole_clearance, edge_clearance, hole_size, hole_to_hole, "
288  "courtyard_clearance, silk_clearance, track_width, annular_width, "
289  "via_diameter, disallow, length, skew, diff_pair_gap, or "
290  "diff_pair_uncoupled" ) );
291  reportError( msg );
292  }
293 
294  if( aRule->FindConstraint( c.m_Type ) )
295  {
296  msg.Printf( _( "Rule already has a '%s' constraint." ), FromUTF8() );
297  reportError( msg );
298  }
299 
300  if( c.m_Type == DISALLOW_CONSTRAINT )
301  {
302  for( token = NextTok(); token != T_RIGHT; token = NextTok() )
303  {
304  if( (int) token == DSN_STRING )
305  token = GetCurStrAsToken();
306 
307  switch( token )
308  {
309  case T_track: c.m_DisallowFlags |= DRC_DISALLOW_TRACKS; break;
310  case T_via: c.m_DisallowFlags |= DRC_DISALLOW_VIAS; break;
311  case T_micro_via: c.m_DisallowFlags |= DRC_DISALLOW_MICRO_VIAS; break;
312  case T_buried_via: c.m_DisallowFlags |= DRC_DISALLOW_BB_VIAS; break;
313  case T_pad: c.m_DisallowFlags |= DRC_DISALLOW_PADS; break;
314  case T_zone: c.m_DisallowFlags |= DRC_DISALLOW_ZONES; break;
315  case T_text: c.m_DisallowFlags |= DRC_DISALLOW_TEXTS; break;
316  case T_graphic: c.m_DisallowFlags |= DRC_DISALLOW_GRAPHICS; break;
317  case T_hole: c.m_DisallowFlags |= DRC_DISALLOW_HOLES; break;
318  case T_footprint: c.m_DisallowFlags |= DRC_DISALLOW_FOOTPRINTS; break;
319 
320  case T_EOF:
321  reportError( _( "Missing ')'." ) );
322  return;
323 
324  default:
325  msg.Printf( _( "Unrecognized item '%s'.| Expected %s." ), FromUTF8(),
326  wxT( "track, via, micro_via, buried_via, pad, zone, text, graphic, "
327  "hole, or footprint." ) );
328  reportError( msg );
329  break;
330  }
331  }
332 
333  if( (int) CurTok() != DSN_RIGHT )
334  reportError( _( "Missing ')'." ) );
335 
336  aRule->AddConstraint( c );
337  return;
338  }
339 
340  for( token = NextTok(); token != T_RIGHT && token != T_EOF; token = NextTok() )
341  {
342  if( token != T_LEFT )
343  reportError( _( "Missing '('." ) );
344 
345  token = NextTok();
346 
347  switch( token )
348  {
349  case T_min:
350  token = NextTok();
351 
352  if( (int) token == DSN_RIGHT )
353  {
354  reportError( _( "Missing min value." ) );
355  break;
356  }
357 
358  parseValueWithUnits( FromUTF8(), value );
359  c.m_Value.SetMin( value );
360 
361  if( (int) NextTok() != DSN_RIGHT )
362  {
363  reportError( wxString::Format( _( "Unrecognized item '%s'." ), FromUTF8() ) );
364  parseUnknown();
365  }
366 
367  break;
368 
369  case T_max:
370  token = NextTok();
371 
372  if( (int) token == DSN_RIGHT )
373  {
374  reportError( _( "Missing max value." ) );
375  break;
376  }
377 
378  parseValueWithUnits( FromUTF8(), value );
379  c.m_Value.SetMax( value );
380 
381  if( (int) NextTok() != DSN_RIGHT )
382  {
383  reportError( wxString::Format( _( "Unrecognized item '%s'." ), FromUTF8() ) );
384  parseUnknown();
385  }
386 
387  break;
388 
389  case T_opt:
390  token = NextTok();
391 
392  if( (int) token == DSN_RIGHT )
393  {
394  reportError( _( "Missing opt value." ) );
395  break;
396  }
397 
398  parseValueWithUnits( FromUTF8(), value );
399  c.m_Value.SetOpt( value );
400 
401  if( (int) NextTok() != DSN_RIGHT )
402  {
403  reportError( wxString::Format( _( "Unrecognized item '%s'." ), FromUTF8() ) );
404  parseUnknown();
405  }
406 
407  break;
408 
409  case T_EOF:
410  reportError( _( "Incomplete statement." ) );
411  return;
412 
413  default:
414  msg.Printf( _( "Unrecognized item '%s'.| Expected %s." ),
415  FromUTF8(),
416  wxT( "min, max, or opt" ) );
417  reportError( msg );
418  parseUnknown();
419  }
420  }
421 
422  if( (int) CurTok() != DSN_RIGHT )
423  reportError( _( "Missing ')'." ) );
424 
425  aRule->AddConstraint( c );
426 }
427 
428 
429 void DRC_RULES_PARSER::parseValueWithUnits( const wxString& aExpr, int& aResult )
430 {
431  auto errorHandler = [&]( const wxString& aMessage, int aOffset )
432  {
433  wxString rest;
434  wxString first = aMessage.BeforeFirst( '|', &rest );
435 
436  if( m_reporter )
437  {
438  wxString msg = wxString::Format( _( "ERROR: <a href='%d:%d'>%s</a>%s" ),
439  CurLineNumber(), CurOffset() + aOffset, first, rest );
440 
442  }
443  else
444  {
445  wxString msg = wxString::Format( _( "ERROR: %s%s" ), first, rest );
446 
447  THROW_PARSE_ERROR( msg, CurSource(), CurLine(), CurLineNumber(),
448  CurOffset() + aOffset );
449  }
450  };
451 
452  PCB_EXPR_EVALUATOR evaluator;
453  evaluator.SetErrorCallback( errorHandler );
454 
455  evaluator.Evaluate( aExpr );
456  aResult = evaluator.Result();
457 }
458 
459 
461 {
462  LSET retVal;
463  int token = NextTok();
464 
465  if( (int) token == DSN_RIGHT )
466  {
467  reportError( _( "Missing layer name or type." ) );
468  return LSET::AllCuMask();
469  }
470  else if( token == T_outer )
471  {
472  retVal = LSET::ExternalCuMask();
473  }
474  else if( token == T_inner )
475  {
476  retVal = LSET::InternalCuMask();
477  }
478  else
479  {
480  wxString layerName = FromUTF8();
481  wxPGChoices& layerMap = ENUM_MAP<PCB_LAYER_ID>::Instance().Choices();
482 
483  for( unsigned ii = 0; ii < layerMap.GetCount(); ++ii )
484  {
485  wxPGChoiceEntry& entry = layerMap[ii];
486 
487  if( entry.GetText().Matches( layerName ) )
488  retVal.set( ToLAYER_ID( entry.GetValue() ) );
489  }
490 
491  if( !retVal.any() )
492  {
493  reportError( wxString::Format( _( "Unrecognized layer '%s'." ), layerName ) );
494  retVal.set( Rescue );
495  }
496  }
497 
498  if( (int) NextTok() != DSN_RIGHT )
499  {
500  reportError( wxString::Format( _( "Unrecognized item '%s'." ), FromUTF8() ) );
501  parseUnknown();
502  }
503 
504  return retVal;
505 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:759
OPT< DRC_CONSTRAINT > FindConstraint(DRC_CONSTRAINT_T aType)
Definition: drc_rule.cpp:53
void reportError(const wxString &aMessage)
REPORTER * m_reporter
virtual bool HasMessage() const =0
Returns true if the reporter client is non-empty.
void SetErrorCallback(std::function< void(const wxString &aMessage, int aOffset)> aCallback)
DRC_RULE_CONDITION * m_Condition
Definition: drc_rule.h:99
void SetMin(T v)
Definition: minoptmax.h:41
wxString m_Name
Definition: drc_rule.h:96
void SetOpt(T v)
Definition: minoptmax.h:43
static ENUM_MAP< T > & Instance()
Definition: property.h:510
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:70
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.
#define DRC_RULE_FILE_VERSION
MINOPTMAX< int > m_Value
Definition: drc_rule.h:145
DRC_RULES_PARSER(const wxString &aSource, const wxString &aSourceDescr)
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:516
#define THROW_PARSE_ERROR(aProblem, aSource, aInputLine, aLineNumber, aByteIndex)
Definition: ki_exception.h:164
void parseValueWithUnits(const wxString &aExpr, int &aResult)
DRC_RULE * parseDRC_RULE()
void Parse(std::vector< DRC_RULE * > &aRules, REPORTER *aReporter)
void SetMax(T v)
Definition: minoptmax.h:42
static LSET InternalCuMask()
Return a complete set of internal copper layers which is all Cu layers except F_Cu and B_Cu.
Definition: lset.cpp:719
static LSET ExternalCuMask()
Return a mask holding the Front and Bottom layers.
Definition: lset.cpp:789
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
wxString m_LayerSource
Definition: drc_rule.h:97
void parseConstraint(DRC_RULE *aRule)
LSET m_LayerCondition
Definition: drc_rule.h:98
void AddConstraint(DRC_CONSTRAINT &aConstraint)
Definition: drc_rule.cpp:46
int m_DisallowFlags
Definition: drc_rule.h:146
bool Evaluate(const wxString &aExpr)
bool Compile(REPORTER *aReporter, int aSourceLine=0, int aSourceOffset=0)
DRC_CONSTRAINT_T m_Type
Definition: drc_rule.h:144
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:914