KiCad PCB EDA Suite
Loading...
Searching...
No Matches
erc.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) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2011 Wayne Stambaugh <[email protected]>
6 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#include <algorithm>
27#include <numeric>
28
29#include "connection_graph.h"
30#include "kiface_ids.h"
31#include <advanced_config.h>
32#include <common.h> // for ExpandEnvVarSubstitutions
33#include <erc/erc.h>
36#include <string_utils.h>
37#include <sch_pin.h>
38#include <project_sch.h>
41#include <sch_bus_entry.h>
42#include <sch_edit_frame.h>
43#include <sch_marker.h>
44#include <sch_reference_list.h>
45#include <sch_rule_area.h>
46#include <sch_sheet.h>
47#include <sch_sheet_pin.h>
48#include <sch_pin.h>
49#include <sch_textbox.h>
50#include <sch_line.h>
51#include <schematic.h>
52#include <symbol_lib_table.h>
55#include <vector>
56#include <wx/ffile.h>
57#include <sim/sim_lib_mgr.h>
58#include <progress_reporter.h>
59#include <kiway.h>
60
61
62/* ERC tests :
63 * 1 - conflicts between connected pins ( example: 2 connected outputs )
64 * 2 - minimal connections requirements ( 1 input *must* be connected to an
65 * output, or a passive pin )
66 */
67
68/*
69 * Minimal ERC requirements:
70 * All pins *must* be connected (except ELECTRICAL_PINTYPE::PT_NC).
71 * When a pin is not connected in schematic, the user must place a "non
72 * connected" symbol to this pin.
73 * This ensures a forgotten connection will be detected.
74 */
75
76// Messages for matrix rows:
77const wxString CommentERC_H[] =
78{
79 _( "Input Pin" ),
80 _( "Output Pin" ),
81 _( "Bidirectional Pin" ),
82 _( "Tri-State Pin" ),
83 _( "Passive Pin" ),
84 _( "Free Pin" ),
85 _( "Unspecified Pin" ),
86 _( "Power Input Pin" ),
87 _( "Power Output Pin" ),
88 _( "Open Collector" ),
89 _( "Open Emitter" ),
90 _( "No Connection" )
91};
92
93// Messages for matrix columns
94const wxString CommentERC_V[] =
95{
96 _( "Input Pin" ),
97 _( "Output Pin" ),
98 _( "Bidirectional Pin" ),
99 _( "Tri-State Pin" ),
100 _( "Passive Pin" ),
101 _( "Free Pin" ),
102 _( "Unspecified Pin" ),
103 _( "Power Input Pin" ),
104 _( "Power Output Pin" ),
105 _( "Open Collector" ),
106 _( "Open Emitter" ),
107 _( "No Connection" )
108};
109
110
111// List of pin types that are considered drivers for usual input pins
112// i.e. pin type = ELECTRICAL_PINTYPE::PT_INPUT, but not PT_POWER_IN
113// that need only a PT_POWER_OUT pin type to be driven
122
123// List of pin types that are considered drivers for power pins
124// In fact only a ELECTRICAL_PINTYPE::PT_POWER_OUT pin type can drive
125// power input pins
126const std::set<ELECTRICAL_PINTYPE> DrivingPowerPinTypes =
127{
129};
130
131// List of pin types that require a driver elsewhere on the net
132const std::set<ELECTRICAL_PINTYPE> DrivenPinTypes =
133{
136};
137
138extern void CheckDuplicatePins( LIB_SYMBOL* aSymbol, std::vector<wxString>& aMessages,
139 UNITS_PROVIDER* aUnitsProvider );
140
141int ERC_TESTER::TestDuplicateSheetNames( bool aCreateMarker )
142{
143 int err_count = 0;
144
145 for( SCH_SCREEN* screen = m_screens.GetFirst(); screen; screen = m_screens.GetNext() )
146 {
147 std::vector<SCH_SHEET*> list;
148
149 for( SCH_ITEM* item : screen->Items().OfType( SCH_SHEET_T ) )
150 list.push_back( static_cast<SCH_SHEET*>( item ) );
151
152 for( size_t i = 0; i < list.size(); i++ )
153 {
154 SCH_SHEET* sheet = list[i];
155
156 for( size_t j = i + 1; j < list.size(); j++ )
157 {
158 SCH_SHEET* test_item = list[j];
159
160 // We have found a second sheet: compare names
161 // we are using case insensitive comparison to avoid mistakes between
162 // similar names like Mysheet and mysheet
163 if( sheet->GetShownName( false ).IsSameAs( test_item->GetShownName( false ), false ) )
164 {
165 if( aCreateMarker )
166 {
168 ercItem->SetItems( sheet, test_item );
169
170 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), sheet->GetPosition() );
171 screen->Append( marker );
172 }
173
174 err_count++;
175 }
176 }
177 }
178 }
179
180 return err_count;
181}
182
183
185{
187
188 auto unresolved =
189 [this]( wxString str )
190 {
191 str = ExpandEnvVarSubstitutions( str, &m_schematic->Project() );
192 return str.Matches( wxS( "*${*}*" ) );
193 };
194
195 auto testAssertion =
196 []( const SCH_ITEM* item, const SCH_SHEET_PATH& sheet, SCH_SCREEN* screen,
197 const wxString& text, const VECTOR2I& pos )
198 {
199 static wxRegEx warningExpr( wxS( "^\\$\\{ERC_WARNING\\s*([^}]*)\\}(.*)$" ) );
200 static wxRegEx errorExpr( wxS( "^\\$\\{ERC_ERROR\\s*([^}]*)\\}(.*)$" ) );
201
202 if( warningExpr.Matches( text ) )
203 {
204 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_GENERIC_WARNING );
205 wxString ercText = warningExpr.GetMatch( text, 1 );
206
207 if( item )
208 ercItem->SetItems( item );
209 else
210 ercText += _( " (in drawing sheet)" );
211
212 ercItem->SetSheetSpecificPath( sheet );
213 ercItem->SetErrorMessage( ercText );
214
215 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), pos );
216 screen->Append( marker );
217
218 return true;
219 }
220
221 if( errorExpr.Matches( text ) )
222 {
223 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_GENERIC_ERROR );
224 wxString ercText = errorExpr.GetMatch( text, 1 );
225
226 if( item )
227 ercItem->SetItems( item );
228 else
229 ercText += _( " (in drawing sheet)" );
230
231 ercItem->SetSheetSpecificPath( sheet );
232 ercItem->SetErrorMessage( ercText );
233
234 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), pos );
235 screen->Append( marker );
236
237 return true;
238 }
239
240 return false;
241 };
242
243 if( aDrawingSheet )
244 {
245 wsItems.SetPageNumber( wxS( "1" ) );
246 wsItems.SetSheetCount( 1 );
247 wsItems.SetFileName( wxS( "dummyFilename" ) );
248 wsItems.SetSheetName( wxS( "dummySheet" ) );
249 wsItems.SetSheetLayer( wxS( "dummyLayer" ) );
250 wsItems.SetProject( &m_schematic->Project() );
251 wsItems.BuildDrawItemsList( aDrawingSheet->GetPageInfo(), aDrawingSheet->GetTitleBlock() );
252 }
253
254 for( const SCH_SHEET_PATH& sheet : m_sheetList )
255 {
256 SCH_SCREEN* screen = sheet.LastScreen();
257
258 for( SCH_ITEM* item : screen->Items().OfType( SCH_LOCATE_ANY_T ) )
259 {
260 if( item->Type() == SCH_SYMBOL_T )
261 {
262 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
263
264 for( SCH_FIELD& field : symbol->GetFields() )
265 {
266 if( unresolved( field.GetShownText( &sheet, true ) ) )
267 {
269 ercItem->SetItems( symbol );
270 ercItem->SetSheetSpecificPath( sheet );
271
272 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), field.GetPosition() );
273 screen->Append( marker );
274 }
275
276 testAssertion( &field, sheet, screen, field.GetText(), field.GetPosition() );
277 }
278
279 if( symbol->GetLibSymbolRef() )
280 {
282 [&]( SCH_ITEM* child )
283 {
284 if( child->Type() == SCH_FIELD_T )
285 {
286 // test only SCH_SYMBOL fields, not LIB_SYMBOL fields
287 }
288 else if( child->Type() == SCH_TEXT_T )
289 {
290 SCH_TEXT* textItem = static_cast<SCH_TEXT*>( child );
291
292 if( unresolved( textItem->GetShownText( &sheet, true ) ) )
293 {
295 ercItem->SetItems( symbol );
296 ercItem->SetSheetSpecificPath( sheet );
297
298 BOX2I bbox = textItem->GetBoundingBox();
299 bbox = symbol->GetTransform().TransformCoordinate( bbox );
300 VECTOR2I pos = bbox.Centre() + symbol->GetPosition();
301
302 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), pos );
303 screen->Append( marker );
304 }
305
306 testAssertion( symbol, sheet, screen, textItem->GetText(),
307 textItem->GetPosition() );
308 }
309 else if( child->Type() == SCH_TEXTBOX_T )
310 {
311 SCH_TEXTBOX* textboxItem = static_cast<SCH_TEXTBOX*>( child );
312
313 if( unresolved( textboxItem->GetShownText( nullptr, &sheet, true ) ) )
314 {
316 ercItem->SetItems( symbol );
317 ercItem->SetSheetSpecificPath( sheet );
318
319 BOX2I bbox = textboxItem->GetBoundingBox();
320 bbox = symbol->GetTransform().TransformCoordinate( bbox );
321 VECTOR2I pos = bbox.Centre() + symbol->GetPosition();
322
323 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), pos );
324 screen->Append( marker );
325 }
326
327 testAssertion( symbol, sheet, screen, textboxItem->GetText(),
328 textboxItem->GetPosition() );
329 }
330 },
332 }
333 }
334 else if( SCH_LABEL_BASE* label = dynamic_cast<SCH_LABEL_BASE*>( item ) )
335 {
336 for( SCH_FIELD& field : label->GetFields() )
337 {
338 if( unresolved( field.GetShownText( &sheet, true ) ) )
339 {
341 ercItem->SetItems( label );
342 ercItem->SetSheetSpecificPath( sheet );
343
344 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), field.GetPosition() );
345 screen->Append( marker );
346 }
347
348 testAssertion( &field, sheet, screen, field.GetText(), field.GetPosition() );
349 }
350 }
351 else if( item->Type() == SCH_SHEET_T )
352 {
353 SCH_SHEET* subSheet = static_cast<SCH_SHEET*>( item );
354
355 for( SCH_FIELD& field : subSheet->GetFields() )
356 {
357 if( unresolved( field.GetShownText( &sheet, true ) ) )
358 {
360 ercItem->SetItems( subSheet );
361 ercItem->SetSheetSpecificPath( sheet );
362
363 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), field.GetPosition() );
364 screen->Append( marker );
365 }
366
367 testAssertion( &field, sheet, screen, field.GetText(), field.GetPosition() );
368 }
369
370 SCH_SHEET_PATH subSheetPath = sheet;
371 subSheetPath.push_back( subSheet );
372
373 for( SCH_SHEET_PIN* pin : subSheet->GetPins() )
374 {
375 if( pin->GetShownText( &subSheetPath, true ).Matches( wxS( "*${*}*" ) ) )
376 {
378 ercItem->SetItems( pin );
379 ercItem->SetSheetSpecificPath( sheet );
380
381 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), pin->GetPosition() );
382 screen->Append( marker );
383 }
384 }
385 }
386 else if( SCH_TEXT* text = dynamic_cast<SCH_TEXT*>( item ) )
387 {
388 if( text->GetShownText( &sheet, true ).Matches( wxS( "*${*}*" ) ) )
389 {
391 ercItem->SetItems( text );
392 ercItem->SetSheetSpecificPath( sheet );
393
394 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), text->GetPosition() );
395 screen->Append( marker );
396 }
397
398 testAssertion( text, sheet, screen, text->GetText(), text->GetPosition() );
399 }
400 else if( SCH_TEXTBOX* textBox = dynamic_cast<SCH_TEXTBOX*>( item ) )
401 {
402 if( textBox->GetShownText( nullptr, &sheet, true ).Matches( wxS( "*${*}*" ) ) )
403 {
405 ercItem->SetItems( textBox );
406 ercItem->SetSheetSpecificPath( sheet );
407
408 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), textBox->GetPosition() );
409 screen->Append( marker );
410 }
411
412 testAssertion( textBox, sheet, screen, textBox->GetText(), textBox->GetPosition() );
413 }
414 }
415
416 for( DS_DRAW_ITEM_BASE* item = wsItems.GetFirst(); item; item = wsItems.GetNext() )
417 {
418 if( DS_DRAW_ITEM_TEXT* text = dynamic_cast<DS_DRAW_ITEM_TEXT*>( item ) )
419 {
420 if( testAssertion( nullptr, sheet, screen, text->GetText(), text->GetPosition() ) )
421 {
422 // Don't run unresolved test
423 }
424 else if( text->GetShownText( true ).Matches( wxS( "*${*}*" ) ) )
425 {
426 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_UNRESOLVED_VARIABLE );
427 ercItem->SetErrorMessage( _( "Unresolved text variable in drawing sheet" ) );
428 ercItem->SetSheetSpecificPath( sheet );
429
430 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), text->GetPosition() );
431 screen->Append( marker );
432 }
433 }
434 }
435 }
436}
437
438
440{
441 int errors = 0;
442
443 for( std::pair<const wxString, SCH_REFERENCE_LIST>& symbol : m_refMap )
444 {
445 SCH_REFERENCE_LIST& refList = symbol.second;
446
447 if( refList.GetCount() == 0 )
448 {
449 wxFAIL; // it should not happen
450 continue;
451 }
452
453 // Reference footprint
454 SCH_SYMBOL* unit = nullptr;
455 wxString unitName;
456 wxString unitFP;
457
458 for( size_t ii = 0; ii < refList.GetCount(); ++ii )
459 {
460 SCH_SHEET_PATH sheetPath = refList.GetItem( ii ).GetSheetPath();
461 unitFP = refList.GetItem( ii ).GetFootprint();
462
463 if( !unitFP.IsEmpty() )
464 {
465 unit = refList.GetItem( ii ).GetSymbol();
466 unitName = unit->GetRef( &sheetPath, true );
467 break;
468 }
469 }
470
471 for( size_t ii = 0; ii < refList.GetCount(); ++ii )
472 {
473 SCH_REFERENCE& secondRef = refList.GetItem( ii );
474 SCH_SYMBOL* secondUnit = secondRef.GetSymbol();
475 wxString secondName = secondUnit->GetRef( &secondRef.GetSheetPath(), true );
476 const wxString secondFp = secondRef.GetFootprint();
477 wxString msg;
478
479 if( unit && !secondFp.IsEmpty() && unitFP != secondFp )
480 {
481 msg.Printf( _( "Different footprints assigned to %s and %s" ),
482 unitName, secondName );
483
484 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_DIFFERENT_UNIT_FP );
485 ercItem->SetErrorMessage( msg );
486 ercItem->SetItems( unit, secondUnit );
487
488 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), secondUnit->GetPosition() );
489 secondRef.GetSheetPath().LastScreen()->Append( marker );
490
491 ++errors;
492 }
493 }
494 }
495
496 return errors;
497}
498
499
501{
502 int errors = 0;
503
504 for( std::pair<const wxString, SCH_REFERENCE_LIST>& symbol : m_refMap )
505 {
506 SCH_REFERENCE_LIST& refList = symbol.second;
507
508 wxCHECK2( refList.GetCount(), continue );
509
510 // Reference unit
511 SCH_REFERENCE& base_ref = refList.GetItem( 0 );
512 SCH_SYMBOL* unit = base_ref.GetSymbol();
513 LIB_SYMBOL* libSymbol = base_ref.GetLibPart();
514
515 if( static_cast<ssize_t>( refList.GetCount() ) == libSymbol->GetUnitCount() )
516 continue;
517
518 std::set<int> lib_units;
519 std::set<int> instance_units;
520 std::set<int> missing_units;
521
522 auto report =
523 [&]( std::set<int>& aMissingUnits, const wxString& aErrorMsg, int aErrorCode )
524 {
525 wxString msg;
526 wxString missing_pin_units = wxS( "[ " );
527 int ii = 0;
528
529 for( int missing_unit : aMissingUnits )
530 {
531 if( ii++ == 3 )
532 {
533 missing_pin_units += wxS( "..." );
534 break;
535 }
536
537 missing_pin_units += libSymbol->GetUnitDisplayName( missing_unit, false ) + ", " ;
538 }
539
540 missing_pin_units.Truncate( missing_pin_units.length() - 2 );
541 missing_pin_units += wxS( " ]" );
542
543 msg.Printf( aErrorMsg, symbol.first, missing_pin_units );
544
545 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( aErrorCode );
546 ercItem->SetErrorMessage( msg );
547 ercItem->SetItems( unit );
548 ercItem->SetSheetSpecificPath( base_ref.GetSheetPath() );
549 ercItem->SetItemsSheetPaths( base_ref.GetSheetPath() );
550
551 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), unit->GetPosition() );
552 base_ref.GetSheetPath().LastScreen()->Append( marker );
553
554 ++errors;
555 };
556
557 for( int ii = 1; ii <= libSymbol->GetUnitCount(); ++ii )
558 lib_units.insert( lib_units.end(), ii );
559
560 for( size_t ii = 0; ii < refList.GetCount(); ++ii )
561 instance_units.insert( instance_units.end(), refList.GetItem( ii ).GetUnit() );
562
563 std::set_difference( lib_units.begin(), lib_units.end(),
564 instance_units.begin(), instance_units.end(),
565 std::inserter( missing_units, missing_units.begin() ) );
566
567 if( !missing_units.empty() && m_settings.IsTestEnabled( ERCE_MISSING_UNIT ) )
568 {
569 report( missing_units, _( "Symbol %s has unplaced units %s" ), ERCE_MISSING_UNIT );
570 }
571
572 std::set<int> missing_power;
573 std::set<int> missing_input;
574 std::set<int> missing_bidi;
575
576 for( int missing_unit : missing_units )
577 {
578 int bodyStyle = 0;
579
580 for( size_t ii = 0; ii < refList.GetCount(); ++ii )
581 {
582 if( refList.GetItem( ii ).GetUnit() == missing_unit )
583 {
584 bodyStyle = refList.GetItem( ii ).GetSymbol()->GetBodyStyle();
585 break;
586 }
587 }
588
589 for( SCH_PIN* pin : libSymbol->GetGraphicalPins( missing_unit, bodyStyle ) )
590 {
591 switch( pin->GetType() )
592 {
594 missing_power.insert( missing_unit );
595 break;
596
598 missing_bidi.insert( missing_unit );
599 break;
600
602 missing_input.insert( missing_unit );
603 break;
604
605 default:
606 break;
607 }
608 }
609 }
610
611 if( !missing_power.empty() && m_settings.IsTestEnabled( ERCE_MISSING_POWER_INPUT_PIN ) )
612 {
613 report( missing_power, _( "Symbol %s has input power pins in units %s that are not placed" ),
615 }
616
617 if( !missing_input.empty() && m_settings.IsTestEnabled( ERCE_MISSING_INPUT_PIN ) )
618 {
619 report( missing_input, _( "Symbol %s has input pins in units %s that are not placed" ),
621 }
622
623 if( !missing_bidi.empty() && m_settings.IsTestEnabled( ERCE_MISSING_BIDI_PIN ) )
624 {
625 report( missing_bidi, _( "Symbol %s has bidirectional pins in units %s that are not placed" ),
627 }
628 }
629
630 return errors;
631}
632
633
635{
636 int err_count = 0;
637 std::shared_ptr<NET_SETTINGS>& settings = m_schematic->Project().GetProjectFile().NetSettings();
638 wxString defaultNetclass = settings->GetDefaultNetclass()->GetName();
639
640 auto logError =
641 [&]( const SCH_SHEET_PATH& sheet, SCH_ITEM* item, const wxString& netclass )
642 {
643 err_count++;
644
645 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_UNDEFINED_NETCLASS );
646
647 ercItem->SetItems( item );
648 ercItem->SetErrorMessage( wxString::Format( _( "Netclass %s is not defined" ), netclass ) );
649
650 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), item->GetPosition() );
651 sheet.LastScreen()->Append( marker );
652 };
653
654 for( const SCH_SHEET_PATH& sheet : m_sheetList )
655 {
656 for( SCH_ITEM* item : sheet.LastScreen()->Items() )
657 {
658 item->RunOnChildren(
659 [&]( SCH_ITEM* aChild )
660 {
661 if( aChild->Type() == SCH_FIELD_T )
662 {
663 SCH_FIELD* field = static_cast<SCH_FIELD*>( aChild );
664
665 if( field->GetCanonicalName() == wxT( "Netclass" ) )
666 {
667 wxString netclass = field->GetShownText( &sheet, false );
668
669 if( !netclass.empty() && !netclass.IsSameAs( defaultNetclass )
670 && !settings->HasNetclass( netclass ) )
671 {
672 logError( sheet, item, netclass );
673 }
674 }
675 }
676
677 return true;
678 },
680 }
681 }
682
683 return err_count;
684}
685
686
688{
689 int err_count = 0;
690
691 for( const SCH_SHEET_PATH& sheet : m_sheetList )
692 {
693 std::map<VECTOR2I, std::vector<SCH_ITEM*>> connMap;
694
695 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_LABEL_T ) )
696 {
697 SCH_LABEL* label = static_cast<SCH_LABEL*>( item );
698
699 for( const VECTOR2I& pt : label->GetConnectionPoints() )
700 connMap[pt].emplace_back( label );
701 }
702
703 for( const std::pair<const VECTOR2I, std::vector<SCH_ITEM*>>& pair : connMap )
704 {
705 std::vector<SCH_ITEM*> lines;
706
707 for( SCH_ITEM* item : sheet.LastScreen()->Items().Overlapping( SCH_LINE_T, pair.first ) )
708 {
709 SCH_LINE* line = static_cast<SCH_LINE*>( item );
710
711 if( line->IsGraphicLine() )
712 continue;
713
714 // If the line is connected at the endpoint, then there will be a junction
715 if( !line->IsEndPoint( pair.first ) )
716 lines.emplace_back( line );
717 }
718
719 if( lines.size() > 1 )
720 {
721 err_count++;
722 lines.resize( 3 ); // Only show the first 3 lines and if there are only two, adds a nullptr
723
724 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_LABEL_MULTIPLE_WIRES );
725 wxString msg = wxString::Format( _( "Label connects more than one wire at %d, %d" ),
726 pair.first.x, pair.first.y );
727
728 ercItem->SetItems( pair.second.front(), lines[0], lines[1], lines[2] );
729 ercItem->SetErrorMessage( msg );
730 ercItem->SetSheetSpecificPath( sheet );
731
732 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), pair.first );
733 sheet.LastScreen()->Append( marker );
734 }
735 }
736 }
737
738 return err_count;
739}
740
741
743{
744 int err_count = 0;
745
746 auto pinStackAlreadyRepresented =
747 []( SCH_PIN* pin, std::vector<SCH_ITEM*>& collection ) -> bool
748 {
749 for( SCH_ITEM*& item : collection )
750 {
751 if( item->Type() == SCH_PIN_T && item->GetParentSymbol() == pin->GetParentSymbol() )
752 {
753 if( pin->IsVisible() && !static_cast<SCH_PIN*>( item )->IsVisible() )
754 item = pin;
755
756 return true;
757 }
758 }
759
760 return false;
761 };
762
763 for( const SCH_SHEET_PATH& sheet : m_sheetList )
764 {
765 std::map<VECTOR2I, std::vector<SCH_ITEM*>> connMap;
766 SCH_SCREEN* screen = sheet.LastScreen();
767
768 for( SCH_ITEM* item : screen->Items().OfType( SCH_SYMBOL_T ) )
769 {
770 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
771
772 for( SCH_PIN* pin : symbol->GetPins( &sheet ) )
773 {
774 std::vector<SCH_ITEM*>& entry = connMap[pin->GetPosition()];
775
776 // Only one pin per pin-stack.
777 if( pinStackAlreadyRepresented( pin, entry ) )
778 continue;
779
780 entry.emplace_back( pin );
781 }
782 }
783
784 for( SCH_ITEM* item : screen->Items().OfType( SCH_LINE_T ) )
785 {
786 SCH_LINE* line = static_cast<SCH_LINE*>( item );
787
788 if( line->IsGraphicLine() )
789 continue;
790
791 for( const VECTOR2I& pt : line->GetConnectionPoints() )
792 connMap[pt].emplace_back( line );
793 }
794
795 for( const std::pair<const VECTOR2I, std::vector<SCH_ITEM*>>& pair : connMap )
796 {
797 if( pair.second.size() >= 4 )
798 {
799 err_count++;
800
801 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_FOUR_WAY_JUNCTION );
802
803 ercItem->SetItems( pair.second[0], pair.second[1], pair.second[2], pair.second[3] );
804
805 wxString msg = wxString::Format( _( "Four items connected at %d, %d" ),
806 pair.first.x, pair.first.y );
807 ercItem->SetErrorMessage( msg );
808
809 ercItem->SetSheetSpecificPath( sheet );
810
811 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), pair.first );
812 sheet.LastScreen()->Append( marker );
813 }
814 }
815 }
816
817 return err_count;
818}
819
820
822{
823 int err_count = 0;
824
825 for( const SCH_SHEET_PATH& sheet : m_sheetList )
826 {
827 std::map<VECTOR2I, std::vector<SCH_ITEM*>> pinMap;
828
829 auto addOther =
830 [&]( const VECTOR2I& pt, SCH_ITEM* aOther )
831 {
832 if( pinMap.count( pt ) )
833 pinMap[pt].emplace_back( aOther );
834 };
835
836 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
837 {
838 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
839
840 for( SCH_PIN* pin : symbol->GetPins( &sheet ) )
841 {
842 if( pin->GetType() == ELECTRICAL_PINTYPE::PT_NC )
843 pinMap[pin->GetPosition()].emplace_back( pin );
844 }
845 }
846
847 for( SCH_ITEM* item : sheet.LastScreen()->Items() )
848 {
849 if( item->Type() == SCH_SYMBOL_T )
850 {
851 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
852
853 for( SCH_PIN* pin : symbol->GetPins( &sheet ) )
854 {
855 if( pin->GetType() != ELECTRICAL_PINTYPE::PT_NC )
856 addOther( pin->GetPosition(), pin );
857 }
858 }
859 else if( item->IsConnectable() && item->Type() != SCH_NO_CONNECT_T )
860 {
861 for( const VECTOR2I& pt : item->GetConnectionPoints() )
862 addOther( pt, item );
863 }
864 }
865
866 for( const std::pair<const VECTOR2I, std::vector<SCH_ITEM*>>& pair : pinMap )
867 {
868 if( pair.second.size() > 1 )
869 {
870 err_count++;
871
872 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_NOCONNECT_CONNECTED );
873
874 ercItem->SetItems( pair.second[0], pair.second[1],
875 pair.second.size() > 2 ? pair.second[2] : nullptr,
876 pair.second.size() > 3 ? pair.second[3] : nullptr );
877 ercItem->SetErrorMessage( _( "Pin with 'no connection' type is connected" ) );
878 ercItem->SetSheetSpecificPath( sheet );
879
880 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), pair.first );
881 sheet.LastScreen()->Append( marker );
882 }
883 }
884 }
885
886 return err_count;
887}
888
889
891{
892 int errors = 0;
893
894 for( const std::pair<NET_NAME_CODE_CACHE_KEY, std::vector<CONNECTION_SUBGRAPH*>> net : m_nets )
895 {
896 using iterator_t = std::vector<ERC_SCH_PIN_CONTEXT>::iterator;
897 std::vector<ERC_SCH_PIN_CONTEXT> pins;
898 std::unordered_map<EDA_ITEM*, SCH_SCREEN*> pinToScreenMap;
899 bool has_noconnect = false;
900
901 for( CONNECTION_SUBGRAPH* subgraph: net.second )
902 {
903 if( subgraph->GetNoConnect() )
904 has_noconnect = true;
905
906 for( SCH_ITEM* item : subgraph->GetItems() )
907 {
908 if( item->Type() == SCH_PIN_T )
909 {
910 pins.emplace_back( static_cast<SCH_PIN*>( item ), subgraph->GetSheet() );
911 pinToScreenMap[item] = subgraph->GetSheet().LastScreen();
912 }
913 }
914 }
915
916 std::sort( pins.begin(), pins.end(),
917 []( const ERC_SCH_PIN_CONTEXT& lhs, const ERC_SCH_PIN_CONTEXT& rhs )
918 {
919 int ret = StrNumCmp( lhs.Pin()->GetParentSymbol()->GetRef( &lhs.Sheet() ),
920 rhs.Pin()->GetParentSymbol()->GetRef( &rhs.Sheet() ) );
921
922 if( ret == 0 )
923 ret = StrNumCmp( lhs.Pin()->GetNumber(), rhs.Pin()->GetNumber() );
924
925 if( ret == 0 )
926 ret = lhs < rhs; // Fallback to hash to guarantee deterministic sort
927
928 return ret < 0;
929 } );
930
931 ERC_SCH_PIN_CONTEXT needsDriver;
933 bool hasDriver = false;
934
935 // We need different drivers for power nets and normal nets.
936 // A power net has at least one pin having the ELECTRICAL_PINTYPE::PT_POWER_IN
937 // and power nets can be driven only by ELECTRICAL_PINTYPE::PT_POWER_OUT pins
938 bool ispowerNet = false;
939
940 for( ERC_SCH_PIN_CONTEXT& refPin : pins )
941 {
942 if( refPin.Pin()->GetType() == ELECTRICAL_PINTYPE::PT_POWER_IN )
943 {
944 ispowerNet = true;
945 break;
946 }
947 }
948
949 std::vector<std::tuple<iterator_t, iterator_t, PIN_ERROR>> pin_mismatches;
950 std::map<iterator_t, int> pin_mismatch_counts;
951
952 for( auto refIt = pins.begin(); refIt != pins.end(); ++refIt )
953 {
954 ERC_SCH_PIN_CONTEXT& refPin = *refIt;
955 ELECTRICAL_PINTYPE refType = refPin.Pin()->GetType();
956
957 if( DrivenPinTypes.contains( refType ) )
958 {
959 // needsDriver will be the pin shown in the error report eventually, so try to
960 // upgrade to a "better" pin if possible: something visible and only a power symbol
961 // if this net needs a power driver
962 if( !needsDriver.Pin()
963 || ( !needsDriver.Pin()->IsVisible() && refPin.Pin()->IsVisible() )
964 || ( ispowerNet != ( needsDriverType == ELECTRICAL_PINTYPE::PT_POWER_IN )
965 && ispowerNet == ( refType == ELECTRICAL_PINTYPE::PT_POWER_IN ) ) )
966 {
967 needsDriver = refPin;
968 needsDriverType = needsDriver.Pin()->GetType();
969 }
970 }
971
972 if( ispowerNet )
973 hasDriver |= ( DrivingPowerPinTypes.count( refType ) != 0 );
974 else
975 hasDriver |= ( DrivingPinTypes.count( refType ) != 0 );
976
977 for( auto testIt = refIt + 1; testIt != pins.end(); ++testIt )
978 {
979 ERC_SCH_PIN_CONTEXT& testPin = *testIt;
980
981 // Multiple pins in the same symbol that share a type,
982 // name and position are considered
983 // "stacked" and shouldn't trigger ERC errors
984 if( refPin.Pin()->IsStacked( testPin.Pin() ) && refPin.Sheet() == testPin.Sheet() )
985 continue;
986
987 ELECTRICAL_PINTYPE testType = testPin.Pin()->GetType();
988
989 if( ispowerNet )
990 hasDriver |= DrivingPowerPinTypes.contains( testType );
991 else
992 hasDriver |= DrivingPinTypes.contains( testType );
993
994 PIN_ERROR erc = m_settings.GetPinMapValue( refType, testType );
995
996 if( erc != PIN_ERROR::OK && m_settings.IsTestEnabled( ERCE_PIN_TO_PIN_WARNING ) )
997 {
998 pin_mismatches.emplace_back( std::tuple<iterator_t, iterator_t, PIN_ERROR>{ refIt, testIt, erc } );
999
1000 if( m_settings.GetERCSortingMetric() == ERC_PIN_SORTING_METRIC::SM_HEURISTICS )
1001 {
1002 pin_mismatch_counts[refIt] = m_settings.GetPinTypeWeight( ( *refIt ).Pin()->GetType() );
1003 pin_mismatch_counts[testIt] = m_settings.GetPinTypeWeight( ( *testIt ).Pin()->GetType() );
1004 }
1005 else
1006 {
1007 if( !pin_mismatch_counts.contains( testIt ) )
1008 pin_mismatch_counts.emplace( testIt, 1 );
1009 else
1010 pin_mismatch_counts[testIt]++;
1011
1012 if( !pin_mismatch_counts.contains( refIt ) )
1013 pin_mismatch_counts.emplace( refIt, 1 );
1014 else
1015 pin_mismatch_counts[refIt]++;
1016 }
1017 }
1018 }
1019 }
1020
1021 std::multimap<size_t, iterator_t, std::greater<size_t>> pins_dsc;
1022
1023 std::transform( pin_mismatch_counts.begin(), pin_mismatch_counts.end(),
1024 std::inserter( pins_dsc, pins_dsc.begin() ),
1025 []( const auto& p )
1026 {
1027 return std::pair<size_t, iterator_t>( p.second, p.first );
1028 } );
1029
1030 for( const auto& [amount, pinItBind] : pins_dsc )
1031 {
1032 auto& pinIt = pinItBind;
1033
1034 if( pin_mismatches.empty() )
1035 break;
1036
1037 SCH_PIN* pin = ( *pinIt ).Pin();
1038 VECTOR2I position = pin->GetPosition();
1039
1040 iterator_t nearest_pin = pins.end();
1041 double smallest_distance = std::numeric_limits<double>::infinity();
1042 PIN_ERROR erc;
1043
1044 std::erase_if(
1045 pin_mismatches,
1046 [&]( const auto& tuple )
1047 {
1048 iterator_t other;
1049
1050 if( pinIt == std::get<0>( tuple ) )
1051 other = std::get<1>( tuple );
1052 else if( pinIt == std::get<1>( tuple ) )
1053 other = std::get<0>( tuple );
1054 else
1055 return false;
1056
1057 if( ( *pinIt ).Sheet().Cmp( ( *other ).Sheet() ) != 0 )
1058 {
1059 if( std::isinf( smallest_distance ) )
1060 {
1061 nearest_pin = other;
1062 erc = std::get<2>( tuple );
1063 }
1064 }
1065 else
1066 {
1067 double distance = position.Distance( ( *other ).Pin()->GetPosition() );
1068
1069 if( std::isinf( smallest_distance ) || distance < smallest_distance )
1070 {
1071 smallest_distance = distance;
1072 nearest_pin = other;
1073 erc = std::get<2>( tuple );
1074 }
1075 }
1076
1077 return true;
1078 } );
1079
1080 if( nearest_pin != pins.end() )
1081 {
1082 SCH_PIN* other_pin = ( *nearest_pin ).Pin();
1083
1086 ercItem->SetItems( pin, other_pin );
1087 ercItem->SetSheetSpecificPath( ( *pinIt ).Sheet() );
1088 ercItem->SetItemsSheetPaths( ( *pinIt ).Sheet(), ( *nearest_pin ).Sheet() );
1089
1090 ercItem->SetErrorMessage( wxString::Format( _( "Pins of type %s and %s are connected" ),
1091 ElectricalPinTypeGetText( pin->GetType() ),
1092 ElectricalPinTypeGetText( other_pin->GetType() ) ) );
1093
1094 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), pin->GetPosition() );
1095 pinToScreenMap[pin]->Append( marker );
1096 errors++;
1097 }
1098 }
1099
1100 if( needsDriver.Pin() && !hasDriver && !has_noconnect )
1101 {
1102 int err_code = ispowerNet ? ERCE_POWERPIN_NOT_DRIVEN : ERCE_PIN_NOT_DRIVEN;
1103
1104 if( m_settings.IsTestEnabled( err_code ) )
1105 {
1106 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( err_code );
1107
1108 ercItem->SetItems( needsDriver.Pin() );
1109 ercItem->SetSheetSpecificPath( needsDriver.Sheet() );
1110 ercItem->SetItemsSheetPaths( needsDriver.Sheet() );
1111
1112 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), needsDriver.Pin()->GetPosition() );
1113 pinToScreenMap[needsDriver.Pin()]->Append( marker );
1114 errors++;
1115 }
1116 }
1117 }
1118
1119 return errors;
1120}
1121
1122
1124{
1125 int errors = 0;
1126
1127 std::unordered_map<wxString, std::pair<wxString, SCH_PIN*>> pinToNetMap;
1128
1129 for( const std::pair<NET_NAME_CODE_CACHE_KEY, std::vector<CONNECTION_SUBGRAPH*>> net : m_nets )
1130 {
1131 const wxString& netName = net.first.Name;
1132
1133 for( CONNECTION_SUBGRAPH* subgraph : net.second )
1134 {
1135 for( SCH_ITEM* item : subgraph->GetItems() )
1136 {
1137 if( item->Type() == SCH_PIN_T )
1138 {
1139 SCH_PIN* pin = static_cast<SCH_PIN*>( item );
1140 const SCH_SHEET_PATH& sheet = subgraph->GetSheet();
1141
1142 if( !pin->GetParentSymbol()->IsMultiUnit() )
1143 continue;
1144
1145 wxString name = pin->GetParentSymbol()->GetRef( &sheet ) + ":" + pin->GetShownNumber();
1146
1147 if( !pinToNetMap.count( name ) )
1148 {
1149 pinToNetMap[name] = std::make_pair( netName, pin );
1150 }
1151 else if( pinToNetMap[name].first != netName )
1152 {
1153 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_DIFFERENT_UNIT_NET );
1154
1155 ercItem->SetErrorMessage( wxString::Format( _( "Pin %s is connected to both %s and %s" ),
1156 pin->GetShownNumber(),
1157 netName,
1158 pinToNetMap[name].first ) );
1159
1160 ercItem->SetItems( pin, pinToNetMap[name].second );
1161 ercItem->SetSheetSpecificPath( sheet );
1162 ercItem->SetItemsSheetPaths( sheet, sheet );
1163
1164 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), pin->GetPosition() );
1165 sheet.LastScreen()->Append( marker );
1166 errors += 1;
1167 }
1168 }
1169 }
1170 }
1171 }
1172
1173 return errors;
1174}
1175
1176
1178{
1179 int errors = 0;
1180
1181 auto isGround = []( const wxString& txt )
1182 {
1183 wxString upper = txt.Upper();
1184 return upper.Contains( wxT( "GND" ) );
1185 };
1186
1187 for( const SCH_SHEET_PATH& sheet : m_sheetList )
1188 {
1189 SCH_SCREEN* screen = sheet.LastScreen();
1190
1191 for( SCH_ITEM* item : screen->Items().OfType( SCH_SYMBOL_T ) )
1192 {
1193 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
1194 bool hasGroundNet = false;
1195 std::vector<SCH_PIN*> mismatched;
1196
1197 for( SCH_PIN* pin : symbol->GetPins( &sheet ) )
1198 {
1199 SCH_CONNECTION* conn = pin->Connection( &sheet );
1200 wxString net = conn ? conn->GetNetName() : wxString();
1201 bool netIsGround = isGround( net );
1202
1203 // We are only interested in power pins
1204 if( pin->GetType() != ELECTRICAL_PINTYPE::PT_POWER_OUT
1205 && pin->GetType() != ELECTRICAL_PINTYPE::PT_POWER_IN )
1206 {
1207 continue;
1208 }
1209
1210 if( netIsGround )
1211 hasGroundNet = true;
1212
1213 if( isGround( pin->GetShownName() ) && !netIsGround )
1214 mismatched.push_back( pin );
1215 }
1216
1217 if( hasGroundNet )
1218 {
1219 for( SCH_PIN* pin : mismatched )
1220 {
1221 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_GROUND_PIN_NOT_GROUND );
1222
1223 ercItem->SetErrorMessage( wxString::Format( _( "Pin %s not connected to ground net" ),
1224 pin->GetShownName() ) );
1225 ercItem->SetItems( pin );
1226 ercItem->SetSheetSpecificPath( sheet );
1227 ercItem->SetItemsSheetPaths( sheet );
1228
1229 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), pin->GetPosition() );
1230 screen->Append( marker );
1231 errors++;
1232 }
1233 }
1234 }
1235 }
1236
1237 return errors;
1238}
1239
1240
1242{
1243 int warnings = 0;
1244
1245 for( const SCH_SHEET_PATH& sheet : m_sheetList )
1246 {
1247 SCH_SCREEN* screen = sheet.LastScreen();
1248
1249 for( SCH_ITEM* item : screen->Items().OfType( SCH_SYMBOL_T ) )
1250 {
1251 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
1252
1253 for( SCH_PIN* pin : symbol->GetPins( &sheet ) )
1254 {
1255 bool valid;
1256 pin->GetStackedPinNumbers( &valid );
1257
1258 if( !valid )
1259 {
1260 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_STACKED_PIN_SYNTAX );
1261 ercItem->SetItems( pin );
1262 ercItem->SetSheetSpecificPath( sheet );
1263 ercItem->SetItemsSheetPaths( sheet );
1264
1265 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), pin->GetPosition() );
1266 screen->Append( marker );
1267 warnings++;
1268 }
1269 }
1270 }
1271 }
1272
1273 return warnings;
1274}
1275
1276
1278{
1279 int errCount = 0;
1280
1281 std::unordered_map<wxString, std::pair<SCH_ITEM*, SCH_SHEET_PATH>> globalLabels;
1282 std::unordered_map<wxString, std::pair<SCH_ITEM*, SCH_SHEET_PATH>> localLabels;
1283
1284 for( const std::pair<NET_NAME_CODE_CACHE_KEY, std::vector<CONNECTION_SUBGRAPH*>> net : m_nets )
1285 {
1286 for( CONNECTION_SUBGRAPH* subgraph : net.second )
1287 {
1288 const SCH_SHEET_PATH& sheet = subgraph->GetSheet();
1289
1290 for( SCH_ITEM* item : subgraph->GetItems() )
1291 {
1292 if( item->Type() == SCH_LABEL_T || item->Type() == SCH_GLOBAL_LABEL_T )
1293 {
1294 SCH_LABEL_BASE* label = static_cast<SCH_LABEL_BASE*>( item );
1295 wxString text = label->GetShownText( &sheet, false );
1296
1297 auto& map = item->Type() == SCH_LABEL_T ? localLabels : globalLabels;
1298
1299 if( !map.count( text ) )
1300 {
1301 map[text] = std::make_pair( label, sheet );
1302 }
1303 }
1304 }
1305 }
1306 }
1307
1308 for( auto& [globalText, globalItem] : globalLabels )
1309 {
1310 for( auto& [localText, localItem] : localLabels )
1311 {
1312 if( globalText == localText )
1313 {
1314 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_SAME_LOCAL_GLOBAL_LABEL );
1315 ercItem->SetItems( globalItem.first, localItem.first );
1316 ercItem->SetSheetSpecificPath( globalItem.second );
1317 ercItem->SetItemsSheetPaths( globalItem.second, localItem.second );
1318
1319 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), globalItem.first->GetPosition() );
1320 globalItem.second.LastScreen()->Append( marker );
1321
1322 errCount++;
1323 }
1324 }
1325 }
1326
1327 return errCount;
1328}
1329
1330
1332{
1333 int errors = 0;
1334 std::unordered_map<wxString, std::vector<std::tuple<wxString, SCH_ITEM*, SCH_SHEET_PATH>>> generalMap;
1335
1336 auto logError =
1337 [&]( const wxString& normalized, SCH_ITEM* item, const SCH_SHEET_PATH& sheet,
1338 const std::tuple<wxString, SCH_ITEM*, SCH_SHEET_PATH>& other )
1339 {
1340 auto& [otherText, otherItem, otherSheet] = other;
1341 ERCE_T typeOfWarning = ERCE_SIMILAR_LABELS;
1342
1343 if( item->Type() == SCH_PIN_T && otherItem->Type() == SCH_PIN_T )
1344 {
1345 //Two Pins
1346 typeOfWarning = ERCE_SIMILAR_POWER;
1347 }
1348 else if( item->Type() == SCH_PIN_T || otherItem->Type() == SCH_PIN_T )
1349 {
1350 //Pin and Label
1351 typeOfWarning = ERCE_SIMILAR_LABEL_AND_POWER;
1352 }
1353 else
1354 {
1355 //Two Labels
1356 typeOfWarning = ERCE_SIMILAR_LABELS;
1357 }
1358
1359 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( typeOfWarning );
1360 ercItem->SetItems( item, otherItem );
1361 ercItem->SetSheetSpecificPath( sheet );
1362 ercItem->SetItemsSheetPaths( sheet, otherSheet );
1363
1364 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), item->GetPosition() );
1365 sheet.LastScreen()->Append( marker );
1366 };
1367
1368 for( const std::pair<NET_NAME_CODE_CACHE_KEY, std::vector<CONNECTION_SUBGRAPH*>> net : m_nets )
1369 {
1370 for( CONNECTION_SUBGRAPH* subgraph : net.second )
1371 {
1372 const SCH_SHEET_PATH& sheet = subgraph->GetSheet();
1373
1374 for( SCH_ITEM* item : subgraph->GetItems() )
1375 {
1376 switch( item->Type() )
1377 {
1378 case SCH_LABEL_T:
1379 case SCH_HIER_LABEL_T:
1380 case SCH_GLOBAL_LABEL_T:
1381 {
1382 SCH_LABEL_BASE* label = static_cast<SCH_LABEL_BASE*>( item );
1383 wxString unnormalized = label->GetShownText( &sheet, false );
1384 wxString normalized = unnormalized.Lower();
1385
1386 generalMap[normalized].emplace_back( std::make_tuple( unnormalized, label, sheet ) );
1387
1388 for( const auto& otherTuple : generalMap.at( normalized ) )
1389 {
1390 const auto& [otherText, otherItem, otherSheet] = otherTuple;
1391
1392 if( unnormalized != otherText )
1393 {
1394 // Similar local labels on different sheets are fine
1395 if( item->Type() == SCH_LABEL_T && otherItem->Type() == SCH_LABEL_T
1396 && sheet != otherSheet )
1397 {
1398 continue;
1399 }
1400
1401 logError( normalized, label, sheet, otherTuple );
1402 errors += 1;
1403 }
1404 }
1405
1406 break;
1407 }
1408 case SCH_PIN_T:
1409 {
1410 SCH_PIN* pin = static_cast<SCH_PIN*>( item );
1411
1412 if( !pin->IsPower() )
1413 continue;
1414
1415 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( pin->GetParentSymbol() );
1416 wxString unnormalized = symbol->GetValue( true, &sheet, false );
1417 wxString normalized = unnormalized.Lower();
1418
1419 generalMap[normalized].emplace_back( std::make_tuple( unnormalized, pin, sheet ) );
1420
1421 for( const auto& otherTuple : generalMap.at( normalized ) )
1422 {
1423 const auto& [otherText, otherItem, otherSheet] = otherTuple;
1424
1425 if( unnormalized != otherText )
1426 {
1427 logError( normalized, pin, sheet, otherTuple );
1428 errors += 1;
1429 }
1430 }
1431
1432 break;
1433 }
1434
1435 default:
1436 break;
1437 }
1438 }
1439 }
1440 }
1441
1442 return errors;
1443}
1444
1445
1447{
1448 wxCHECK( m_schematic, 0 );
1449
1451 wxString msg;
1452 int err_count = 0;
1453
1454 for( SCH_SCREEN* screen = m_screens.GetFirst(); screen; screen = m_screens.GetNext() )
1455 {
1456 std::vector<SCH_MARKER*> markers;
1457
1458 for( SCH_ITEM* item : screen->Items().OfType( SCH_SYMBOL_T ) )
1459 {
1460 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
1461 LIB_SYMBOL* libSymbolInSchematic = symbol->GetLibSymbolRef().get();
1462
1463 if( !libSymbolInSchematic )
1464 continue;
1465
1466 wxString libName = symbol->GetLibId().GetLibNickname();
1467 const LIB_TABLE_ROW* libTableRow = libTable->FindRow( libName, true );
1468
1469 if( !libTableRow )
1470 {
1471 if( m_settings.IsTestEnabled( ERCE_LIB_SYMBOL_ISSUES ) )
1472 {
1473 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_LIB_SYMBOL_ISSUES );
1474 ercItem->SetItems( symbol );
1475 msg.Printf( _( "The current configuration does not include the symbol library '%s'" ),
1476 UnescapeString( libName ) );
1477 ercItem->SetErrorMessage( msg );
1478
1479 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1480 }
1481
1482 continue;
1483 }
1484 else if( !libTable->HasLibrary( libName, true ) )
1485 {
1486 if( m_settings.IsTestEnabled( ERCE_LIB_SYMBOL_ISSUES ) )
1487 {
1488 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_LIB_SYMBOL_ISSUES );
1489 ercItem->SetItems( symbol );
1490 msg.Printf( _( "The symbol library '%s' is not enabled in the current configuration" ),
1491 UnescapeString( libName ) );
1492 ercItem->SetErrorMessage( msg );
1493
1494 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1495 }
1496
1497 continue;
1498 }
1499 else if( !libTableRow->LibraryExists() )
1500 {
1501 if( m_settings.IsTestEnabled( ERCE_LIB_SYMBOL_ISSUES ) )
1502 {
1503 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_LIB_SYMBOL_ISSUES );
1504 ercItem->SetItems( symbol );
1505 msg.Printf( _( "The symbol library '%s' was not found at '%s'" ),
1506 UnescapeString( libName ),
1507 libTableRow->GetFullURI( true ) );
1508 ercItem->SetErrorMessage( msg );
1509
1510 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1511 }
1512
1513 continue;
1514 }
1515
1516 wxString symbolName = symbol->GetLibId().GetLibItemName();
1517 LIB_SYMBOL* libSymbol = SchGetLibSymbol( symbol->GetLibId(), libTable );
1518
1519 if( libSymbol == nullptr )
1520 {
1521 if( m_settings.IsTestEnabled( ERCE_LIB_SYMBOL_ISSUES ) )
1522 {
1523 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_LIB_SYMBOL_ISSUES );
1524 ercItem->SetItems( symbol );
1525 msg.Printf( _( "Symbol '%s' not found in symbol library '%s'" ),
1526 UnescapeString( symbolName ),
1527 UnescapeString( libName ) );
1528 ercItem->SetErrorMessage( msg );
1529
1530 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1531 }
1532
1533 continue;
1534 }
1535
1536 std::unique_ptr<LIB_SYMBOL> flattenedSymbol = libSymbol->Flatten();
1538
1539 if( m_settings.IsTestEnabled( ERCE_LIB_SYMBOL_MISMATCH ) )
1540 {
1541 // We have to check for duplicate pins first as they will cause Compare() to fail.
1542 std::vector<wxString> messages;
1543 UNITS_PROVIDER unitsProvider( schIUScale, EDA_UNITS::MILS );
1544 CheckDuplicatePins( libSymbolInSchematic, messages, &unitsProvider );
1545
1546 if( !messages.empty() )
1547 {
1548 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_DUPLICATE_PIN_ERROR );
1549 ercItem->SetItems( symbol );
1550 msg.Printf( _( "Symbol '%s' has multiple pins with the same pin number" ),
1551 UnescapeString( symbolName ) );
1552 ercItem->SetErrorMessage( msg );
1553
1554 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1555 }
1556 else if( flattenedSymbol->Compare( *libSymbolInSchematic, flags ) != 0 )
1557 {
1558 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_LIB_SYMBOL_MISMATCH );
1559 ercItem->SetItems( symbol );
1560 msg.Printf( _( "Symbol '%s' doesn't match copy in library '%s'" ),
1561 UnescapeString( symbolName ),
1562 UnescapeString( libName ) );
1563 ercItem->SetErrorMessage( msg );
1564
1565 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1566 }
1567 }
1568 }
1569
1570 for( SCH_MARKER* marker : markers )
1571 {
1572 screen->Append( marker );
1573 err_count += 1;
1574 }
1575 }
1576
1577 return err_count;
1578}
1579
1580
1582{
1583 wxCHECK( m_schematic, 0 );
1584
1585 wxString msg;
1586 int err_count = 0;
1587
1588 typedef int (*TESTER_FN_PTR)( const wxString&, PROJECT* );
1589
1590 TESTER_FN_PTR linkTester = (TESTER_FN_PTR) aCvPcb->IfaceOrAddress( KIFACE_TEST_FOOTPRINT_LINK );
1591
1592 for( SCH_SHEET_PATH& sheet : m_sheetList )
1593 {
1594 std::vector<SCH_MARKER*> markers;
1595
1596 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
1597 {
1598 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
1599 wxString footprint = symbol->GetFootprintFieldText( true, &sheet, false );
1600
1601 if( footprint.IsEmpty() )
1602 continue;
1603
1604 LIB_ID fpID;
1605
1606 if( fpID.Parse( footprint, true ) >= 0 )
1607 {
1608 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_FOOTPRINT_LINK_ISSUES );
1609 msg.Printf( _( "'%s' is not a valid footprint identifier" ), footprint );
1610 ercItem->SetErrorMessage( msg );
1611 ercItem->SetItems( symbol );
1612 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1613 continue;
1614 }
1615
1616 wxString libName = fpID.GetLibNickname();
1617 wxString fpName = fpID.GetLibItemName();
1618 int ret = (linkTester)( footprint, aProject );
1619
1621 {
1622 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_FOOTPRINT_LINK_ISSUES );
1623 msg.Printf( _( "The current configuration does not include the footprint library '%s'" ),
1624 libName );
1625 ercItem->SetErrorMessage( msg );
1626 ercItem->SetItems( symbol );
1627 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1628 }
1630 {
1631 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_FOOTPRINT_LINK_ISSUES );
1632 msg.Printf( _( "The footprint library '%s' is not enabled in the current configuration" ),
1633 libName );
1634 ercItem->SetErrorMessage( msg );
1635 ercItem->SetItems( symbol );
1636 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1637 }
1639 {
1640 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_FOOTPRINT_LINK_ISSUES );
1641 msg.Printf( _( "Footprint '%s' not found in library '%s'" ),
1642 fpName,
1643 libName );
1644 ercItem->SetErrorMessage( msg );
1645 ercItem->SetItems( symbol );
1646 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1647 }
1648 }
1649
1650 for( SCH_MARKER* marker : markers )
1651 {
1652 sheet.LastScreen()->Append( marker );
1653 err_count += 1;
1654 }
1655 }
1656
1657 return err_count;
1658}
1659
1660
1662{
1663 wxCHECK( m_schematic, 0 );
1664
1665 wxString msg;
1666 int err_count = 0;
1667
1668 for( SCH_SHEET_PATH& sheet : m_sheetList )
1669 {
1670 std::vector<SCH_MARKER*> markers;
1671
1672 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
1673 {
1674 SCH_SYMBOL* sch_symbol = static_cast<SCH_SYMBOL*>( item );
1675 std::unique_ptr<LIB_SYMBOL>& lib_symbol = sch_symbol->GetLibSymbolRef();
1676
1677 if( !lib_symbol )
1678 continue;
1679
1680 wxArrayString filters = lib_symbol->GetFPFilters();
1681
1682 if( filters.empty() )
1683 continue;
1684
1685 wxString lowerId = sch_symbol->GetFootprintFieldText( true, &sheet, false ).Lower();
1686 LIB_ID footprint;
1687
1688 if( footprint.Parse( lowerId ) > 0 )
1689 continue;
1690
1691 wxString lowerItemName = footprint.GetUniStringLibItemName().Lower();
1692 bool found = false;
1693
1694 for( wxString filter : filters )
1695 {
1696 filter.LowerCase();
1697
1698 // If the filter contains a ':' character, include the library name in the pattern
1699 if( filter.Contains( wxS( ":" ) ) )
1700 found |= lowerId.Matches( filter );
1701 else
1702 found |= lowerItemName.Matches( filter );
1703
1704 if( found )
1705 break;
1706 }
1707
1708 if( !found )
1709 {
1710 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_FOOTPRINT_LINK_ISSUES );
1711 msg.Printf( _( "Assigned footprint (%s) doesn't match footprint filters (%s)" ),
1712 footprint.GetUniStringLibItemName(),
1713 wxJoin( filters, ' ' ) );
1714 ercItem->SetErrorMessage( msg );
1715 ercItem->SetItems( sch_symbol );
1716 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), sch_symbol->GetPosition() ) );
1717 }
1718 }
1719
1720 for( SCH_MARKER* marker : markers )
1721 {
1722 sheet.LastScreen()->Append( marker );
1723 err_count += 1;
1724 }
1725 }
1726
1727 return err_count;
1728}
1729
1730
1732{
1733 const int gridSize = m_schematic->Settings().m_ConnectionGridSize;
1734 int err_count = 0;
1735
1736 for( SCH_SCREEN* screen = m_screens.GetFirst(); screen; screen = m_screens.GetNext() )
1737 {
1738 std::vector<SCH_MARKER*> markers;
1739
1740 for( SCH_ITEM* item : screen->Items() )
1741 {
1742 if( item->Type() == SCH_LINE_T && item->IsConnectable() )
1743 {
1744 SCH_LINE* line = static_cast<SCH_LINE*>( item );
1745
1746 if( ( line->GetStartPoint().x % gridSize ) != 0
1747 || ( line->GetStartPoint().y % gridSize ) != 0 )
1748 {
1749 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_ENDPOINT_OFF_GRID );
1750 ercItem->SetItems( line );
1751
1752 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), line->GetStartPoint() ) );
1753 }
1754 else if( ( line->GetEndPoint().x % gridSize ) != 0
1755 || ( line->GetEndPoint().y % gridSize ) != 0 )
1756 {
1757 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_ENDPOINT_OFF_GRID );
1758 ercItem->SetItems( line );
1759
1760 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), line->GetEndPoint() ) );
1761 }
1762 }
1763 if( item->Type() == SCH_BUS_WIRE_ENTRY_T )
1764 {
1765 SCH_BUS_WIRE_ENTRY* entry = static_cast<SCH_BUS_WIRE_ENTRY*>( item );
1766
1767 for( const VECTOR2I& point : entry->GetConnectionPoints() )
1768 {
1769 if( ( point.x % gridSize ) != 0
1770 || ( point.y % gridSize ) != 0 )
1771 {
1772 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_ENDPOINT_OFF_GRID );
1773 ercItem->SetItems( entry );
1774
1775 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), point ) );
1776 }
1777 }
1778 }
1779 else if( item->Type() == SCH_SYMBOL_T )
1780 {
1781 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
1782
1783 for( SCH_PIN* pin : symbol->GetPins( nullptr ) )
1784 {
1785 if( pin->GetType() == ELECTRICAL_PINTYPE::PT_NC )
1786 continue;
1787
1788 VECTOR2I pinPos = pin->GetPosition();
1789
1790 if( ( pinPos.x % gridSize ) != 0 || ( pinPos.y % gridSize ) != 0 )
1791 {
1792 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_ENDPOINT_OFF_GRID );
1793 ercItem->SetItems( pin );
1794
1795 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), pinPos ) );
1796 break;
1797 }
1798 }
1799 }
1800 }
1801
1802 for( SCH_MARKER* marker : markers )
1803 {
1804 screen->Append( marker );
1805 err_count += 1;
1806 }
1807 }
1808
1809 return err_count;
1810}
1811
1812
1814{
1815 WX_STRING_REPORTER reporter;
1816 int err_count = 0;
1817 SIM_LIB_MGR libMgr( &m_schematic->Project() );
1818
1819 for( SCH_SHEET_PATH& sheet : m_sheetList )
1820 {
1821 if( sheet.GetExcludedFromSim() )
1822 continue;
1823
1824 std::vector<SCH_MARKER*> markers;
1825
1826 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
1827 {
1828 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
1829
1830 // Power symbols and other symbols which have the reference starting with "#" are
1831 // not included in simulation
1832 if( symbol->GetRef( &sheet ).StartsWith( '#' ) || symbol->ResolveExcludedFromSim() )
1833 continue;
1834
1835 // Reset for each symbol
1836 reporter.Clear();
1837
1838 SIM_LIBRARY::MODEL model = libMgr.CreateModel( &sheet, *symbol, true, 0, reporter );
1839
1840 if( reporter.HasMessage() )
1841 {
1842 wxString msg = reporter.GetMessages();
1843 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_SIMULATION_MODEL );
1844
1845 //Remove \n and \r at e.o.l if any:
1846 msg.Trim();
1847
1848 ercItem->SetErrorMessage( msg );
1849 ercItem->SetItems( symbol );
1850
1851 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1852 }
1853 }
1854
1855 for( SCH_MARKER* marker : markers )
1856 {
1857 sheet.LastScreen()->Append( marker );
1858 err_count += 1;
1859 }
1860 }
1861
1862 return err_count;
1863}
1864
1865
1867 KIFACE* aCvPcb, PROJECT* aProject, PROGRESS_REPORTER* aProgressReporter )
1868{
1869 m_sheetList.AnnotatePowerSymbols();
1870
1871 // Test duplicate sheet names inside a given sheet. While one can have multiple references
1872 // to the same file, each must have a unique name.
1873 if( m_settings.IsTestEnabled( ERCE_DUPLICATE_SHEET_NAME ) )
1874 {
1875 if( aProgressReporter )
1876 aProgressReporter->AdvancePhase( _( "Checking sheet names..." ) );
1877
1879 }
1880
1881 // The connection graph has a whole set of ERC checks it can run
1882 if( aProgressReporter )
1883 aProgressReporter->AdvancePhase( _( "Checking conflicts..." ) );
1884
1885 // If we are using the new connectivity, make sure that we do a full-rebuild
1886 if( aEditFrame )
1887 {
1888 if( ADVANCED_CFG::GetCfg().m_IncrementalConnectivity )
1889 aEditFrame->RecalculateConnections( nullptr, GLOBAL_CLEANUP );
1890 else
1891 aEditFrame->RecalculateConnections( nullptr, NO_CLEANUP );
1892 }
1893
1894 m_schematic->ConnectionGraph()->RunERC();
1895
1896 if( aProgressReporter )
1897 aProgressReporter->AdvancePhase( _( "Checking units..." ) );
1898
1899 // Test is all units of each multiunit symbol have the same footprint assigned.
1900 if( m_settings.IsTestEnabled( ERCE_DIFFERENT_UNIT_FP ) )
1901 {
1902 if( aProgressReporter )
1903 aProgressReporter->AdvancePhase( _( "Checking footprints..." ) );
1904
1906 }
1907
1908 if( m_settings.IsTestEnabled( ERCE_MISSING_UNIT )
1909 || m_settings.IsTestEnabled( ERCE_MISSING_INPUT_PIN )
1910 || m_settings.IsTestEnabled( ERCE_MISSING_POWER_INPUT_PIN )
1911 || m_settings.IsTestEnabled( ERCE_MISSING_BIDI_PIN ) )
1912 {
1914 }
1915
1916 if( aProgressReporter )
1917 aProgressReporter->AdvancePhase( _( "Checking pins..." ) );
1918
1919 if( m_settings.IsTestEnabled( ERCE_DIFFERENT_UNIT_NET ) )
1921
1922 // Test pins on each net against the pin connection table
1923 if( m_settings.IsTestEnabled( ERCE_PIN_TO_PIN_ERROR )
1924 || m_settings.IsTestEnabled( ERCE_POWERPIN_NOT_DRIVEN )
1925 || m_settings.IsTestEnabled( ERCE_PIN_NOT_DRIVEN ) )
1926 {
1927 TestPinToPin();
1928 }
1929
1930 if( m_settings.IsTestEnabled( ERCE_GROUND_PIN_NOT_GROUND ) )
1932
1933 if( m_settings.IsTestEnabled( ERCE_STACKED_PIN_SYNTAX ) )
1935
1936 // Test similar labels (i;e. labels which are identical when
1937 // using case insensitive comparisons)
1938 if( m_settings.IsTestEnabled( ERCE_SIMILAR_LABELS )
1939 || m_settings.IsTestEnabled( ERCE_SIMILAR_POWER )
1940 || m_settings.IsTestEnabled( ERCE_SIMILAR_LABEL_AND_POWER ) )
1941 {
1942 if( aProgressReporter )
1943 aProgressReporter->AdvancePhase( _( "Checking similar labels..." ) );
1944
1946 }
1947
1948 if( m_settings.IsTestEnabled( ERCE_SAME_LOCAL_GLOBAL_LABEL ) )
1949 {
1950 if( aProgressReporter )
1951 aProgressReporter->AdvancePhase( _( "Checking local and global labels..." ) );
1952
1954 }
1955
1956 if( m_settings.IsTestEnabled( ERCE_UNRESOLVED_VARIABLE ) )
1957 {
1958 if( aProgressReporter )
1959 aProgressReporter->AdvancePhase( _( "Checking for unresolved variables..." ) );
1960
1961 TestTextVars( aDrawingSheet );
1962 }
1963
1964 if( m_settings.IsTestEnabled( ERCE_SIMULATION_MODEL ) )
1965 {
1966 if( aProgressReporter )
1967 aProgressReporter->AdvancePhase( _( "Checking SPICE models..." ) );
1968
1970 }
1971
1972 if( m_settings.IsTestEnabled( ERCE_NOCONNECT_CONNECTED ) )
1973 {
1974 if( aProgressReporter )
1975 aProgressReporter->AdvancePhase( _( "Checking no connect pins for connections..." ) );
1976
1978 }
1979
1980 if( m_settings.IsTestEnabled( ERCE_LIB_SYMBOL_ISSUES )
1981 || m_settings.IsTestEnabled( ERCE_LIB_SYMBOL_MISMATCH ) )
1982 {
1983 if( aProgressReporter )
1984 aProgressReporter->AdvancePhase( _( "Checking for library symbol issues..." ) );
1985
1987 }
1988
1989 if( m_settings.IsTestEnabled( ERCE_FOOTPRINT_LINK_ISSUES ) && aCvPcb )
1990 {
1991 if( aProgressReporter )
1992 aProgressReporter->AdvancePhase( _( "Checking for footprint link issues..." ) );
1993
1994 TestFootprintLinkIssues( aCvPcb, aProject );
1995 }
1996
1997 if( m_settings.IsTestEnabled( ERCE_FOOTPRINT_FILTERS ) )
1998 {
1999 if( aProgressReporter )
2000 aProgressReporter->AdvancePhase( _( "Checking footprint assignments against footprint filters..." ) );
2001
2003 }
2004
2005 if( m_settings.IsTestEnabled( ERCE_ENDPOINT_OFF_GRID ) )
2006 {
2007 if( aProgressReporter )
2008 aProgressReporter->AdvancePhase( _( "Checking for off grid pins and wires..." ) );
2009
2011 }
2012
2013 if( m_settings.IsTestEnabled( ERCE_FOUR_WAY_JUNCTION ) )
2014 {
2015 if( aProgressReporter )
2016 aProgressReporter->AdvancePhase( _( "Checking for four way junctions..." ) );
2017
2019 }
2020
2021 if( m_settings.IsTestEnabled( ERCE_LABEL_MULTIPLE_WIRES ) )
2022 {
2023 if( aProgressReporter )
2024 aProgressReporter->AdvancePhase( _( "Checking for labels on more than one wire..." ) );
2025
2027 }
2028
2029 if( m_settings.IsTestEnabled( ERCE_UNDEFINED_NETCLASS ) )
2030 {
2031 if( aProgressReporter )
2032 aProgressReporter->AdvancePhase( _( "Checking for undefined netclasses..." ) );
2033
2035 }
2036
2037 m_schematic->ResolveERCExclusionsPostUpdate();
2038}
const char * name
constexpr EDA_IU_SCALE schIUScale
Definition base_units.h:114
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
constexpr Vec Centre() const
Definition box2.h:97
A subgraph is a set of items that are electrically connected on a single sheet.
const std::set< SCH_ITEM * > & GetItems() const
Provide a read-only reference to the items in the subgraph.
const SCH_ITEM * GetNoConnect() const
const SCH_SHEET_PATH & GetSheet() const
Base class to handle basic graphic items.
Store the list of graphic items: rect, lines, polygons and texts to draw/plot the title block and fra...
DS_DRAW_ITEM_BASE * GetFirst()
void BuildDrawItemsList(const PAGE_INFO &aPageInfo, const TITLE_BLOCK &aTitleBlock)
Drawing or plot the drawing sheet.
void SetFileName(const wxString &aFileName)
Set the filename to draw/plot.
void SetSheetName(const wxString &aSheetName)
Set the sheet name to draw/plot.
void SetSheetLayer(const wxString &aSheetLayer)
Set the sheet layer to draw/plot.
void SetSheetCount(int aSheetCount)
Set the value of the count of sheets, for basic inscriptions.
void SetPageNumber(const wxString &aPageNumber)
Set the value of the sheet number.
DS_DRAW_ITEM_BASE * GetNext()
void SetProject(const PROJECT *aProject)
A graphic text.
const PAGE_INFO & GetPageInfo()
const TITLE_BLOCK & GetTitleBlock()
virtual VECTOR2I GetPosition() const
Definition eda_item.h:272
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:110
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition eda_text.h:98
EE_TYPE OfType(KICAD_T aType) const
Definition sch_rtree.h:241
static std::shared_ptr< ERC_ITEM > Create(int aErrorCode)
Constructs an ERC_ITEM for the given error code.
Definition erc_item.cpp:307
A class used to associate a SCH_PIN with its owning SCH_SHEET_PATH, in order to handle ERC checks acr...
const SCH_SHEET_PATH & Sheet() const
Get the SCH_SHEET_PATH context for the paired SCH_PIN.
SCH_PIN * Pin() const
Get the SCH_PIN for this context.
int TestLibSymbolIssues()
Test symbols for changed library symbols and broken symbol library links.
Definition erc.cpp:1446
const NET_MAP & m_nets
Definition erc.h:193
int TestStackedPinNotation()
Checks for pin numbers that resemble stacked pin notation but are invalid.
Definition erc.cpp:1241
void TestTextVars(DS_PROXY_VIEW_ITEM *aDrawingSheet)
Check for any unresolved text variable references.
Definition erc.cpp:184
int TestPinToPin()
Checks the full netlist against the pin-to-pin connectivity requirements.
Definition erc.cpp:890
int TestSimilarLabels()
Checks for labels that differ only in capitalization.
Definition erc.cpp:1331
SCH_MULTI_UNIT_REFERENCE_MAP m_refMap
Definition erc.h:192
SCH_SCREENS m_screens
Definition erc.h:191
int TestFootprintLinkIssues(KIFACE *aCvPcb, PROJECT *aProject)
Test footprint links against the current footprint libraries.
Definition erc.cpp:1581
int TestOffGridEndpoints()
Test pins and wire ends for being off grid.
Definition erc.cpp:1731
int TestDuplicateSheetNames(bool aCreateMarker)
Inside a given sheet, one cannot have sheets with duplicate names (file names can be duplicated).
Definition erc.cpp:141
int TestSameLocalGlobalLabel()
Checks for global and local labels with the same name.
Definition erc.cpp:1277
int TestMultUnitPinConflicts()
Checks if shared pins on multi-unit symbols have been connected to different nets.
Definition erc.cpp:1123
int TestNoConnectPins()
In KiCad 5 and earlier, you could connect stuff up to pins with NC electrical type.
Definition erc.cpp:821
int TestFootprintFilters()
Test symbols to ensure that assigned footprint passes any given footprint filters.
Definition erc.cpp:1661
ERC_SETTINGS & m_settings
Definition erc.h:189
int TestFourWayJunction()
Test to see if there are potentially confusing 4-way junctions in the schematic.
Definition erc.cpp:742
int TestMissingNetclasses()
Tests for netclasses that are referenced but not defined.
Definition erc.cpp:634
int TestSimModelIssues()
Test SPICE models for various issues.
Definition erc.cpp:1813
SCH_SHEET_LIST m_sheetList
Definition erc.h:190
int TestGroundPins()
Checks for ground-labeled pins not on a ground net while another pin is.
Definition erc.cpp:1177
SCHEMATIC * m_schematic
Definition erc.h:188
void RunTests(DS_PROXY_VIEW_ITEM *aDrawingSheet, SCH_EDIT_FRAME *aEditFrame, KIFACE *aCvPcb, PROJECT *aProject, PROGRESS_REPORTER *aProgressReporter)
Definition erc.cpp:1866
int TestMissingUnits()
Test for uninstantiated units of multi unit symbols.
Definition erc.cpp:500
int TestLabelMultipleWires()
Test to see if there are labels that are connected to more than one wire.
Definition erc.cpp:687
int TestMultiunitFootprints()
Test if all units of each multiunit symbol have the same footprint assigned.
Definition erc.cpp:439
A logical library item identifier and consists of various portions much like a URI.
Definition lib_id.h:49
int Parse(const UTF8 &aId, bool aFix=false)
Parse LIB_ID with the information from aId.
Definition lib_id.cpp:52
const wxString GetUniStringLibItemName() const
Get strings for display messages in dialogs.
Definition lib_id.h:112
const UTF8 & GetLibItemName() const
Definition lib_id.h:102
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition lib_id.h:87
Define a library symbol object.
Definition lib_symbol.h:87
void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction, RECURSE_MODE aMode) override
std::vector< SCH_PIN * > GetGraphicalPins(int aUnit=0, int aBodyStyle=0) const
Graphical pins: Return schematic pin objects as drawn (unexpanded), filtered by unit/body.
int GetUnitCount() const override
std::unique_ptr< LIB_SYMBOL > Flatten() const
Return a flattened symbol inheritance to the caller.
wxString GetUnitDisplayName(int aUnit, bool aLabel) const override
Return the user-defined display name for aUnit for symbols with units.
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
virtual bool LibraryExists() const =0
const wxString GetFullURI(bool aSubstituted=false) const
Return the full location specifying URI for the LIB, either in original UI form or in environment var...
bool HasLibrary(const wxString &aNickname, bool aCheckEnabled=false) const
Test for the existence of aNickname in the library table.
A progress reporter interface for use in multi-threaded environments.
virtual void AdvancePhase()=0
Use the next available virtual zone of the dialog progress bar.
static SYMBOL_LIB_TABLE * SchSymbolLibTable(PROJECT *aProject)
Accessor for project symbol library table.
Container for project specific data.
Definition project.h:65
virtual bool HasMessage() const
Returns true if any messages were reported.
Definition reporter.h:134
std::vector< VECTOR2I > GetConnectionPoints() const override
Add all the connection points for this item to aPoints.
Class for a wire to bus entry.
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
wxString GetNetName() const
Schematic editor (Eeschema) main window.
void RecalculateConnections(SCH_COMMIT *aCommit, SCH_CLEANUP_FLAGS aCleanupFlags, PROGRESS_REPORTER *aProgressReporter=nullptr)
Generate the connection data for the entire schematic hierarchy.
wxString GetCanonicalName() const
Get a non-language-specific name for a field which can be used for storage, variable look-up,...
wxString GetShownText(const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition sch_item.h:167
int GetBodyStyle() const
Definition sch_item.h:247
bool ResolveExcludedFromSim(const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const
Definition sch_item.cpp:274
wxString GetShownText(const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const override
std::vector< VECTOR2I > GetConnectionPoints() const override
Add all the connection points for this item to aPoints.
Segment description base class to describe items which have 2 end points (track, wire,...
Definition sch_line.h:42
std::vector< VECTOR2I > GetConnectionPoints() const override
Add all the connection points for this item to aPoints.
Definition sch_line.cpp:717
VECTOR2I GetEndPoint() const
Definition sch_line.h:148
VECTOR2I GetStartPoint() const
Definition sch_line.h:139
bool IsEndPoint(const VECTOR2I &aPoint) const override
Test if aPt is an end point of this schematic object.
Definition sch_line.h:91
bool IsGraphicLine() const
Return if the line is a graphic (non electrical line)
Definition sch_line.cpp:983
bool IsVisible() const
Definition sch_pin.cpp:386
VECTOR2I GetPosition() const override
Definition sch_pin.cpp:255
bool IsStacked(const SCH_PIN *aPin) const
Definition sch_pin.cpp:475
ELECTRICAL_PINTYPE GetType() const
Definition sch_pin.cpp:312
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
SCH_REFERENCE & GetItem(size_t aIdx)
A helper to define a symbol's reference designator in a schematic.
const SCH_SHEET_PATH & GetSheetPath() const
const wxString GetFootprint() const
SCH_SYMBOL * GetSymbol() const
LIB_SYMBOL * GetLibPart() const
void Append(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
EE_RTREE & Items()
Get the full RTree, usually for iterating.
Definition sch_screen.h:117
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
VECTOR2I GetPosition() const override
Definition sch_shape.h:85
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
SCH_SCREEN * LastScreen()
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition sch_sheet.h:47
std::vector< SCH_FIELD > & GetFields()
Return a reference to the vector holding the sheet's fields.
Definition sch_sheet.h:87
VECTOR2I GetPosition() const override
Definition sch_sheet.h:443
std::vector< SCH_SHEET_PIN * > & GetPins()
Definition sch_sheet.h:187
wxString GetShownName(bool aAllowExtraText) const
Definition sch_sheet.h:109
Schematic symbol object.
Definition sch_symbol.h:75
const wxString GetValue(bool aResolve, const SCH_SHEET_PATH *aPath, bool aAllowExtraText) const override
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly) const override
Populate a std::vector with SCH_FIELDs, sorted in ordinal order.
const wxString GetFootprintFieldText(bool aResolve, const SCH_SHEET_PATH *aPath, bool aAllowExtraText) const
VECTOR2I GetPosition() const override
Definition sch_symbol.h:808
std::vector< SCH_PIN * > GetPins(const SCH_SHEET_PATH *aSheet) const
Retrieve a list of the SCH_PINs for the given sheet path.
const LIB_ID & GetLibId() const override
Definition sch_symbol.h:164
std::unique_ptr< LIB_SYMBOL > & GetLibSymbolRef()
Definition sch_symbol.h:183
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const override
virtual wxString GetShownText(const RENDER_SETTINGS *aSettings, const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const
VECTOR2I GetPosition() const override
Definition sch_text.h:150
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition sch_text.cpp:296
virtual wxString GetShownText(const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const
Definition sch_text.cpp:317
SIM_MODEL & CreateModel(SIM_MODEL::TYPE aType, const std::vector< SCH_PIN * > &aPins, REPORTER &aReporter)
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
const TRANSFORM & GetTransform() const
Definition symbol.h:218
VECTOR2I TransformCoordinate(const VECTOR2I &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition transform.cpp:44
double Distance(const VECTOR2< extended_type > &aVector) const
Compute the distance between two vectors.
Definition vector2d.h:561
A wrapper for reporting to a wxString object.
Definition reporter.h:191
void Clear() override
Definition reporter.cpp:83
const wxString & GetMessages() const
Definition reporter.cpp:77
const wxString ExpandEnvVarSubstitutions(const wxString &aString, const PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition common.cpp:355
The common library.
#define FOR_ERC_DRC
Expand '${var-name}' templates in text.
Definition common.h:91
#define _(s)
@ NO_RECURSE
Definition eda_item.h:52
void CheckDuplicatePins(LIB_SYMBOL *aSymbol, std::vector< wxString > &aMessages, UNITS_PROVIDER *aUnitsProvider)
const wxString CommentERC_V[]
Definition erc.cpp:94
const wxString CommentERC_H[]
Definition erc.cpp:77
const std::set< ELECTRICAL_PINTYPE > DrivenPinTypes
Definition erc.cpp:132
const std::set< ELECTRICAL_PINTYPE > DrivingPinTypes
Definition erc.cpp:114
const std::set< ELECTRICAL_PINTYPE > DrivingPowerPinTypes
Definition erc.cpp:126
ERCE_T
ERC error codes.
@ ERCE_POWERPIN_NOT_DRIVEN
Power input pin connected to some others pins but no power out pin to drive it.
@ ERCE_SIMILAR_POWER
2 power pins are equal for case insensitive comparisons.
@ ERCE_MISSING_POWER_INPUT_PIN
Symbol has power input pins that are not placed on the schematic.
@ ERCE_GROUND_PIN_NOT_GROUND
A ground-labeled pin is not on a ground net while another pin is.
@ ERCE_SIMILAR_LABELS
2 labels are equal for case insensitive comparisons.
@ ERCE_STACKED_PIN_SYNTAX
Pin name resembles stacked pin notation.
@ ERCE_ENDPOINT_OFF_GRID
Pin or wire-end off grid.
@ ERCE_SAME_LOCAL_GLOBAL_LABEL
2 labels are equal for case insensitive comparisons.
@ ERCE_SIMILAR_LABEL_AND_POWER
label and pin are equal for case insensitive comparisons.
@ ERCE_FOOTPRINT_LINK_ISSUES
The footprint link is invalid, or points to a missing (or inactive) footprint or library.
@ ERCE_DUPLICATE_PIN_ERROR
@ ERCE_DIFFERENT_UNIT_NET
Shared pin in a multi-unit symbol is connected to more than one net.
@ ERCE_FOUR_WAY_JUNCTION
A four-way junction was found.
@ ERCE_UNDEFINED_NETCLASS
A netclass was referenced but not defined.
@ ERCE_UNRESOLVED_VARIABLE
A text variable could not be resolved.
@ ERCE_SIMULATION_MODEL
An error was found in the simulation model.
@ ERCE_LIB_SYMBOL_MISMATCH
Symbol doesn't match copy in library.
@ ERCE_GENERIC_ERROR
@ ERCE_DIFFERENT_UNIT_FP
Different units of the same symbol have different footprints assigned.
@ ERCE_NOCONNECT_CONNECTED
A no connect symbol is connected to more than 1 pin.
@ ERCE_PIN_TO_PIN_WARNING
@ ERCE_PIN_NOT_DRIVEN
Pin connected to some others pins but no pin to drive it.
@ ERCE_MISSING_INPUT_PIN
Symbol has input pins that are not placed.
@ ERCE_MISSING_UNIT
Symbol has units that are not placed on the schematic.
@ ERCE_DUPLICATE_SHEET_NAME
Duplicate sheet names within a given sheet.
@ ERCE_MISSING_BIDI_PIN
Symbol has bi-directional pins that are not placed.
@ ERCE_LIB_SYMBOL_ISSUES
Symbol not found in active libraries.
@ ERCE_FOOTPRINT_FILTERS
The assigned footprint doesn't match the footprint filters.
@ ERCE_GENERIC_WARNING
@ ERCE_LABEL_MULTIPLE_WIRES
A label is connected to more than one wire.
@ ERCE_PIN_TO_PIN_ERROR
PIN_ERROR
The values a pin-to-pin entry in the pin matrix can take on.
@ KIFACE_TEST_FOOTPRINT_LINK_LIBRARY_NOT_ENABLED
Definition kiface_ids.h:62
@ KIFACE_TEST_FOOTPRINT_LINK
Definition kiface_ids.h:60
@ KIFACE_TEST_FOOTPRINT_LINK_NO_LIBRARY
Definition kiface_ids.h:61
@ KIFACE_TEST_FOOTPRINT_LINK_NO_FOOTPRINT
Definition kiface_ids.h:63
ELECTRICAL_PINTYPE
The symbol library pin object electrical types used in ERC tests.
Definition pin_type.h:36
@ PT_INPUT
usual pin input: must be connected
Definition pin_type.h:37
@ PT_NC
not connected (must be left open)
Definition pin_type.h:50
@ PT_OUTPUT
usual output
Definition pin_type.h:38
@ PT_TRISTATE
tri state bus pin
Definition pin_type.h:40
@ PT_BIDI
input or output (like port for a microprocessor)
Definition pin_type.h:39
@ PT_POWER_OUT
output of a regulator: intended to be connected to power input pins
Definition pin_type.h:47
@ PT_POWER_IN
power input (GND, VCC for ICs). Must be connected to a power output.
Definition pin_type.h:46
@ PT_UNSPECIFIED
unknown electrical properties: creates always a warning when connected
Definition pin_type.h:45
@ PT_PASSIVE
pin for passive symbols: must be connected, and can be connected to any pin.
Definition pin_type.h:43
wxString ElectricalPinTypeGetText(ELECTRICAL_PINTYPE)
Definition pin_type.cpp:207
static float distance(const SFVEC2UI &a, const SFVEC2UI &b)
LIB_SYMBOL * SchGetLibSymbol(const LIB_ID &aLibId, SYMBOL_LIB_TABLE *aLibTable, SYMBOL_LIB *aCacheLib, wxWindow *aParent, bool aShowErrorMsg)
Load symbol from symbol library table.
@ NO_CLEANUP
Definition schematic.h:75
@ GLOBAL_CLEANUP
Definition schematic.h:77
wxString UnescapeString(const wxString &aSource)
Implement a participant in the KIWAY alchemy.
Definition kiway.h:153
virtual void * IfaceOrAddress(int aDataId)=0
Return pointer to the requested object.
@ SCH_LINE_T
Definition typeinfo.h:167
@ SCH_NO_CONNECT_T
Definition typeinfo.h:164
@ SCH_SYMBOL_T
Definition typeinfo.h:176
@ SCH_FIELD_T
Definition typeinfo.h:154
@ SCH_LABEL_T
Definition typeinfo.h:171
@ SCH_LOCATE_ANY_T
Definition typeinfo.h:203
@ SCH_SHEET_T
Definition typeinfo.h:179
@ SCH_HIER_LABEL_T
Definition typeinfo.h:173
@ SCH_TEXT_T
Definition typeinfo.h:155
@ SCH_BUS_WIRE_ENTRY_T
Definition typeinfo.h:165
@ SCH_TEXTBOX_T
Definition typeinfo.h:156
@ SCH_GLOBAL_LABEL_T
Definition typeinfo.h:172
@ SCH_PIN_T
Definition typeinfo.h:157
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695