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
114const std::set<ELECTRICAL_PINTYPE> DrivingPinTypes =
115 {
121 };
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->Prj() );
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->Prj() );
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 {
281 symbol->GetLibSymbolRef()->RunOnChildren(
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 {
294 auto ercItem = ERC_ITEM::Create( ERCE_UNRESOLVED_VARIABLE );
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 {
315 auto ercItem = ERC_ITEM::Create( ERCE_UNRESOLVED_VARIABLE );
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 },
331 RECURSE_MODE::NO_RECURSE );
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 wxString msg;
442 int err_count = 0;
443 std::vector<std::shared_ptr<BUS_ALIAS>> aliases;
444
445 for( SCH_SCREEN* screen = m_screens.GetFirst(); screen; screen = m_screens.GetNext() )
446 {
447 const auto& screen_aliases = screen->GetBusAliases();
448
449 for( const std::shared_ptr<BUS_ALIAS>& alias : screen_aliases )
450 {
451 std::vector<wxString> aliasMembers = alias->Members();
452 std::sort( aliasMembers.begin(), aliasMembers.end() );
453
454 for( const std::shared_ptr<BUS_ALIAS>& test : aliases )
455 {
456 std::vector<wxString> testMembers = test->Members();
457 std::sort( testMembers.begin(), testMembers.end() );
458
459 if( alias->GetName() == test->GetName() && aliasMembers != testMembers )
460 {
461 msg.Printf( _( "Bus alias %s has conflicting definitions on %s and %s" ),
462 alias->GetName(),
463 alias->GetParent()->GetFileName(),
464 test->GetParent()->GetFileName() );
465
466 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_BUS_ALIAS_CONFLICT );
467 ercItem->SetErrorMessage( msg );
468
469 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), VECTOR2I() );
470 test->GetParent()->Append( marker );
471
472 ++err_count;
473 }
474 }
475 }
476
477 aliases.insert( aliases.end(), screen_aliases.begin(), screen_aliases.end() );
478 }
479
480 return err_count;
481}
482
483
485{
486 int errors = 0;
487
488 for( std::pair<const wxString, SCH_REFERENCE_LIST>& symbol : m_refMap )
489 {
490 SCH_REFERENCE_LIST& refList = symbol.second;
491
492 if( refList.GetCount() == 0 )
493 {
494 wxFAIL; // it should not happen
495 continue;
496 }
497
498 // Reference footprint
499 SCH_SYMBOL* unit = nullptr;
500 wxString unitName;
501 wxString unitFP;
502
503 for( size_t ii = 0; ii < refList.GetCount(); ++ii )
504 {
505 SCH_SHEET_PATH sheetPath = refList.GetItem( ii ).GetSheetPath();
506 unitFP = refList.GetItem( ii ).GetFootprint();
507
508 if( !unitFP.IsEmpty() )
509 {
510 unit = refList.GetItem( ii ).GetSymbol();
511 unitName = unit->GetRef( &sheetPath, true );
512 break;
513 }
514 }
515
516 for( size_t ii = 0; ii < refList.GetCount(); ++ii )
517 {
518 SCH_REFERENCE& secondRef = refList.GetItem( ii );
519 SCH_SYMBOL* secondUnit = secondRef.GetSymbol();
520 wxString secondName = secondUnit->GetRef( &secondRef.GetSheetPath(), true );
521 const wxString secondFp = secondRef.GetFootprint();
522 wxString msg;
523
524 if( unit && !secondFp.IsEmpty() && unitFP != secondFp )
525 {
526 msg.Printf( _( "Different footprints assigned to %s and %s" ),
527 unitName, secondName );
528
529 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_DIFFERENT_UNIT_FP );
530 ercItem->SetErrorMessage( msg );
531 ercItem->SetItems( unit, secondUnit );
532
533 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), secondUnit->GetPosition() );
534 secondRef.GetSheetPath().LastScreen()->Append( marker );
535
536 ++errors;
537 }
538 }
539 }
540
541 return errors;
542}
543
544
546{
547 int errors = 0;
548
549 for( std::pair<const wxString, SCH_REFERENCE_LIST>& symbol : m_refMap )
550 {
551 SCH_REFERENCE_LIST& refList = symbol.second;
552
553 wxCHECK2( refList.GetCount(), continue );
554
555 // Reference unit
556 SCH_REFERENCE& base_ref = refList.GetItem( 0 );
557 SCH_SYMBOL* unit = base_ref.GetSymbol();
558 LIB_SYMBOL* libSymbol = base_ref.GetLibPart();
559
560 if( static_cast<ssize_t>( refList.GetCount() ) == libSymbol->GetUnitCount() )
561 continue;
562
563 std::set<int> lib_units;
564 std::set<int> instance_units;
565 std::set<int> missing_units;
566
567 auto report =
568 [&]( std::set<int>& aMissingUnits, const wxString& aErrorMsg, int aErrorCode )
569 {
570 wxString msg;
571 wxString missing_pin_units = wxS( "[ " );
572 int ii = 0;
573
574 for( int missing_unit : aMissingUnits )
575 {
576 if( ii++ == 3 )
577 {
578 missing_pin_units += wxS( "....." );
579 break;
580 }
581
582 missing_pin_units += libSymbol->GetUnitDisplayName( missing_unit ) + ", " ;
583 }
584
585 missing_pin_units.Truncate( missing_pin_units.length() - 2 );
586 missing_pin_units += wxS( " ]" );
587
588 msg.Printf( aErrorMsg, symbol.first, missing_pin_units );
589
590 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( aErrorCode );
591 ercItem->SetErrorMessage( msg );
592 ercItem->SetItems( unit );
593 ercItem->SetSheetSpecificPath( base_ref.GetSheetPath() );
594 ercItem->SetItemsSheetPaths( base_ref.GetSheetPath() );
595
596 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), unit->GetPosition() );
597 base_ref.GetSheetPath().LastScreen()->Append( marker );
598
599 ++errors;
600 };
601
602 for( int ii = 1; ii <= libSymbol->GetUnitCount(); ++ii )
603 lib_units.insert( lib_units.end(), ii );
604
605 for( size_t ii = 0; ii < refList.GetCount(); ++ii )
606 instance_units.insert( instance_units.end(), refList.GetItem( ii ).GetUnit() );
607
608 std::set_difference( lib_units.begin(), lib_units.end(),
609 instance_units.begin(), instance_units.end(),
610 std::inserter( missing_units, missing_units.begin() ) );
611
612 if( !missing_units.empty() && m_settings.IsTestEnabled( ERCE_MISSING_UNIT ) )
613 {
614 report( missing_units, _( "Symbol %s has unplaced units %s" ), ERCE_MISSING_UNIT );
615 }
616
617 std::set<int> missing_power;
618 std::set<int> missing_input;
619 std::set<int> missing_bidi;
620
621 for( int missing_unit : missing_units )
622 {
623 int bodyStyle = 0;
624
625 for( size_t ii = 0; ii < refList.GetCount(); ++ii )
626 {
627 if( refList.GetItem( ii ).GetUnit() == missing_unit )
628 {
629 bodyStyle = refList.GetItem( ii ).GetSymbol()->GetBodyStyle();
630 break;
631 }
632 }
633
634 for( SCH_PIN* pin : libSymbol->GetPins( missing_unit, bodyStyle ) )
635 {
636 switch( pin->GetType() )
637 {
638 case ELECTRICAL_PINTYPE::PT_POWER_IN:
639 missing_power.insert( missing_unit );
640 break;
641
642 case ELECTRICAL_PINTYPE::PT_BIDI:
643 missing_bidi.insert( missing_unit );
644 break;
645
646 case ELECTRICAL_PINTYPE::PT_INPUT:
647 missing_input.insert( missing_unit );
648 break;
649
650 default:
651 break;
652 }
653 }
654 }
655
656 if( !missing_power.empty() && m_settings.IsTestEnabled( ERCE_MISSING_POWER_INPUT_PIN ) )
657 {
658 report( missing_power,
659 _( "Symbol %s has input power pins in units %s that are not placed." ),
661 }
662
663 if( !missing_input.empty() && m_settings.IsTestEnabled( ERCE_MISSING_INPUT_PIN ) )
664 {
665 report( missing_input,
666 _( "Symbol %s has input pins in units %s that are not placed." ),
668 }
669
670 if( !missing_bidi.empty() && m_settings.IsTestEnabled( ERCE_MISSING_BIDI_PIN ) )
671 {
672 report( missing_bidi,
673 _( "Symbol %s has bidirectional pins in units %s that are not placed." ),
675 }
676 }
677
678 return errors;
679}
680
681
683{
684 int err_count = 0;
685 std::shared_ptr<NET_SETTINGS>& settings = m_schematic->Prj().GetProjectFile().NetSettings();
686 wxString defaultNetclass = settings->GetDefaultNetclass()->GetName();
687
688 auto logError =
689 [&]( const SCH_SHEET_PATH& sheet, SCH_ITEM* item, const wxString& netclass )
690 {
691 err_count++;
692
693 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_UNDEFINED_NETCLASS );
694
695 ercItem->SetItems( item );
696 ercItem->SetErrorMessage( wxString::Format( _( "Netclass %s is not defined" ),
697 netclass ) );
698
699 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), item->GetPosition() );
700 sheet.LastScreen()->Append( marker );
701 };
702
703 for( const SCH_SHEET_PATH& sheet : m_sheetList )
704 {
705 for( SCH_ITEM* item : sheet.LastScreen()->Items() )
706 {
707 item->RunOnChildren(
708 [&]( SCH_ITEM* aChild )
709 {
710 if( aChild->Type() == SCH_FIELD_T )
711 {
712 SCH_FIELD* field = static_cast<SCH_FIELD*>( aChild );
713
714 if( field->GetCanonicalName() == wxT( "Netclass" ) )
715 {
716 wxString netclass = field->GetShownText( &sheet, false );
717
718 if( !netclass.IsSameAs( defaultNetclass )
719 && !settings->HasNetclass( netclass ) )
720 {
721 logError( sheet, item, netclass );
722 }
723 }
724 }
725
726 return true;
727 },
728 RECURSE_MODE::NO_RECURSE );
729 }
730 }
731
732 return err_count;
733}
734
735
737{
738 int err_count = 0;
739
740 for( const SCH_SHEET_PATH& sheet : m_sheetList )
741 {
742 std::map<VECTOR2I, std::vector<SCH_ITEM*>> connMap;
743
744 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_LABEL_T ) )
745 {
746 SCH_LABEL* label = static_cast<SCH_LABEL*>( item );
747
748 for( const VECTOR2I& pt : label->GetConnectionPoints() )
749 connMap[pt].emplace_back( label );
750 }
751
752 for( const std::pair<const VECTOR2I, std::vector<SCH_ITEM*>>& pair : connMap )
753 {
754 std::vector<SCH_ITEM*> lines;
755
756 for( SCH_ITEM* item : sheet.LastScreen()->Items().Overlapping( SCH_LINE_T, pair.first ) )
757 {
758 SCH_LINE* line = static_cast<SCH_LINE*>( item );
759
760 if( line->IsGraphicLine() )
761 continue;
762
763 // If the line is connected at the endpoint, then there will be a junction
764 if( !line->IsEndPoint( pair.first ) )
765 lines.emplace_back( line );
766 }
767
768 if( lines.size() > 1 )
769 {
770 err_count++;
771 lines.resize( 3 ); // Only show the first 3 lines and if there are only two, adds a nullptr
772
773 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_LABEL_MULTIPLE_WIRES );
774 wxString msg = wxString::Format( _( "Label connects more than one wire at %d, %d" ),
775 pair.first.x, pair.first.y );
776
777 ercItem->SetItems( pair.second.front(), lines[0], lines[1], lines[2] );
778 ercItem->SetErrorMessage( msg );
779 ercItem->SetSheetSpecificPath( sheet );
780
781 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), pair.first );
782 sheet.LastScreen()->Append( marker );
783 }
784 }
785 }
786
787 return err_count;
788}
789
790
792{
793 int err_count = 0;
794
795 auto pinStackAlreadyRepresented =
796 []( SCH_PIN* pin, std::vector<SCH_ITEM*>& collection ) -> bool
797 {
798 for( SCH_ITEM*& item : collection )
799 {
800 if( item->Type() == SCH_PIN_T && item->GetParentSymbol() == pin->GetParentSymbol() )
801 {
802 if( pin->IsVisible() && !static_cast<SCH_PIN*>( item )->IsVisible() )
803 item = pin;
804
805 return true;
806 }
807 }
808
809 return false;
810 };
811
812 for( const SCH_SHEET_PATH& sheet : m_sheetList )
813 {
814 std::map<VECTOR2I, std::vector<SCH_ITEM*>> connMap;
815 SCH_SCREEN* screen = sheet.LastScreen();
816
817 for( SCH_ITEM* item : screen->Items().OfType( SCH_SYMBOL_T ) )
818 {
819 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
820
821 for( SCH_PIN* pin : symbol->GetPins( &sheet ) )
822 {
823 std::vector<SCH_ITEM*>& entry = connMap[pin->GetPosition()];
824
825 // Only one pin per pin-stack.
826 if( pinStackAlreadyRepresented( pin, entry ) )
827 continue;
828
829 entry.emplace_back( pin );
830 }
831 }
832
833 for( SCH_ITEM* item : screen->Items().OfType( SCH_LINE_T ) )
834 {
835 SCH_LINE* line = static_cast<SCH_LINE*>( item );
836
837 if( line->IsGraphicLine() )
838 continue;
839
840 for( const VECTOR2I& pt : line->GetConnectionPoints() )
841 connMap[pt].emplace_back( line );
842 }
843
844 for( const std::pair<const VECTOR2I, std::vector<SCH_ITEM*>>& pair : connMap )
845 {
846 if( pair.second.size() >= 4 )
847 {
848 err_count++;
849
850 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_FOUR_WAY_JUNCTION );
851
852 ercItem->SetItems( pair.second[0], pair.second[1], pair.second[2], pair.second[3] );
853
854 wxString msg = wxString::Format( _( "Four items connected at %d, %d" ),
855 pair.first.x, pair.first.y );
856 ercItem->SetErrorMessage( msg );
857
858 ercItem->SetSheetSpecificPath( sheet );
859
860 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), pair.first );
861 sheet.LastScreen()->Append( marker );
862 }
863 }
864 }
865
866 return err_count;
867}
868
869
871{
872 int err_count = 0;
873
874 for( const SCH_SHEET_PATH& sheet : m_sheetList )
875 {
876 std::map<VECTOR2I, std::vector<SCH_ITEM*>> pinMap;
877
878 auto addOther =
879 [&]( const VECTOR2I& pt, SCH_ITEM* aOther )
880 {
881 if( pinMap.count( pt ) )
882 pinMap[pt].emplace_back( aOther );
883 };
884
885 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
886 {
887 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
888
889 for( SCH_PIN* pin : symbol->GetPins( &sheet ) )
890 {
891 if( pin->GetLibPin()->GetType() == ELECTRICAL_PINTYPE::PT_NC )
892 pinMap[pin->GetPosition()].emplace_back( pin );
893 }
894 }
895
896 for( SCH_ITEM* item : sheet.LastScreen()->Items() )
897 {
898 if( item->Type() == SCH_SYMBOL_T )
899 {
900 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
901
902 for( SCH_PIN* pin : symbol->GetPins( &sheet ) )
903 {
904 if( pin->GetLibPin()->GetType() != ELECTRICAL_PINTYPE::PT_NC )
905 addOther( pin->GetPosition(), pin );
906 }
907 }
908 else if( item->IsConnectable() && item->Type() != SCH_NO_CONNECT_T )
909 {
910 for( const VECTOR2I& pt : item->GetConnectionPoints() )
911 addOther( pt, item );
912 }
913 }
914
915 for( const std::pair<const VECTOR2I, std::vector<SCH_ITEM*>>& pair : pinMap )
916 {
917 if( pair.second.size() > 1 )
918 {
919 err_count++;
920
921 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_NOCONNECT_CONNECTED );
922
923 ercItem->SetItems( pair.second[0], pair.second[1],
924 pair.second.size() > 2 ? pair.second[2] : nullptr,
925 pair.second.size() > 3 ? pair.second[3] : nullptr );
926 ercItem->SetErrorMessage( _( "Pin with 'no connection' type is connected" ) );
927 ercItem->SetSheetSpecificPath( sheet );
928
929 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), pair.first );
930 sheet.LastScreen()->Append( marker );
931 }
932 }
933 }
934
935 return err_count;
936}
937
938
940{
941 int errors = 0;
942
943 for( const std::pair<NET_NAME_CODE_CACHE_KEY, std::vector<CONNECTION_SUBGRAPH*>> net : m_nets )
944 {
945 using iterator_t = std::vector<ERC_SCH_PIN_CONTEXT>::iterator;
946 std::vector<ERC_SCH_PIN_CONTEXT> pins;
947 std::unordered_map<EDA_ITEM*, SCH_SCREEN*> pinToScreenMap;
948 bool has_noconnect = false;
949
950 for( CONNECTION_SUBGRAPH* subgraph: net.second )
951 {
952 if( subgraph->GetNoConnect() )
953 has_noconnect = true;
954
955 for( SCH_ITEM* item : subgraph->GetItems() )
956 {
957 if( item->Type() == SCH_PIN_T )
958 {
959 pins.emplace_back( static_cast<SCH_PIN*>( item ), subgraph->GetSheet() );
960 pinToScreenMap[item] = subgraph->GetSheet().LastScreen();
961 }
962 }
963 }
964
965 std::sort( pins.begin(), pins.end(),
966 []( const ERC_SCH_PIN_CONTEXT& lhs, const ERC_SCH_PIN_CONTEXT& rhs )
967 {
968 int ret = StrNumCmp( lhs.Pin()->GetParentSymbol()->GetRef( &lhs.Sheet() ),
969 rhs.Pin()->GetParentSymbol()->GetRef( &rhs.Sheet() ) );
970
971 if( ret == 0 )
972 ret = StrNumCmp( lhs.Pin()->GetNumber(), rhs.Pin()->GetNumber() );
973
974 if( ret == 0 )
975 ret = lhs < rhs; // Fallback to hash to guarantee deterministic sort
976
977 return ret < 0;
978 } );
979
980 ERC_SCH_PIN_CONTEXT needsDriver;
981 ELECTRICAL_PINTYPE needsDriverType = ELECTRICAL_PINTYPE::PT_UNSPECIFIED;
982 bool hasDriver = false;
983
984 // We need different drivers for power nets and normal nets.
985 // A power net has at least one pin having the ELECTRICAL_PINTYPE::PT_POWER_IN
986 // and power nets can be driven only by ELECTRICAL_PINTYPE::PT_POWER_OUT pins
987 bool ispowerNet = false;
988
989 for( ERC_SCH_PIN_CONTEXT& refPin : pins )
990 {
991 if( refPin.Pin()->GetType() == ELECTRICAL_PINTYPE::PT_POWER_IN )
992 {
993 ispowerNet = true;
994 break;
995 }
996 }
997
998 std::vector<std::tuple<iterator_t, iterator_t, PIN_ERROR>> pin_mismatches;
999 std::map<iterator_t, int> pin_mismatch_counts;
1000
1001 for( auto refIt = pins.begin(); refIt != pins.end(); ++refIt )
1002 {
1003 ERC_SCH_PIN_CONTEXT& refPin = *refIt;
1004 ELECTRICAL_PINTYPE refType = refPin.Pin()->GetType();
1005
1006 if( DrivenPinTypes.contains( refType ) )
1007 {
1008 // needsDriver will be the pin shown in the error report eventually, so try to
1009 // upgrade to a "better" pin if possible: something visible and only a power symbol
1010 // if this net needs a power driver
1011 if( !needsDriver.Pin()
1012 || ( !needsDriver.Pin()->IsVisible() && refPin.Pin()->IsVisible() )
1013 || ( ispowerNet != ( needsDriverType == ELECTRICAL_PINTYPE::PT_POWER_IN )
1014 && ispowerNet == ( refType == ELECTRICAL_PINTYPE::PT_POWER_IN ) ) )
1015 {
1016 needsDriver = refPin;
1017 needsDriverType = needsDriver.Pin()->GetType();
1018 }
1019 }
1020
1021 if( ispowerNet )
1022 hasDriver |= ( DrivingPowerPinTypes.count( refType ) != 0 );
1023 else
1024 hasDriver |= ( DrivingPinTypes.count( refType ) != 0 );
1025
1026 for( auto testIt = refIt + 1; testIt != pins.end(); ++testIt )
1027 {
1028 ERC_SCH_PIN_CONTEXT& testPin = *testIt;
1029
1030 // Multiple pins in the same symbol that share a type,
1031 // name and position are considered
1032 // "stacked" and shouldn't trigger ERC errors
1033 if( refPin.Pin()->IsStacked( testPin.Pin() ) && refPin.Sheet() == testPin.Sheet() )
1034 continue;
1035
1036 ELECTRICAL_PINTYPE testType = testPin.Pin()->GetType();
1037
1038 if( ispowerNet )
1039 hasDriver |= DrivingPowerPinTypes.contains( testType );
1040 else
1041 hasDriver |= DrivingPinTypes.contains( testType );
1042
1043 PIN_ERROR erc = m_settings.GetPinMapValue( refType, testType );
1044
1045 if( erc != PIN_ERROR::OK && m_settings.IsTestEnabled( ERCE_PIN_TO_PIN_WARNING ) )
1046 {
1047 pin_mismatches.emplace_back(
1048 std::tuple<iterator_t, iterator_t, PIN_ERROR>{ refIt, testIt, erc } );
1049
1050 if( m_settings.GetERCSortingMetric() == ERC_PIN_SORTING_METRIC::SM_HEURISTICS )
1051 {
1052 pin_mismatch_counts[refIt] =
1053 m_settings.GetPinTypeWeight( ( *refIt ).Pin()->GetType() );
1054
1055 pin_mismatch_counts[testIt] =
1056 m_settings.GetPinTypeWeight( ( *testIt ).Pin()->GetType() );
1057 }
1058 else
1059 {
1060 if( !pin_mismatch_counts.contains( testIt ) )
1061 pin_mismatch_counts.emplace( testIt, 1 );
1062 else
1063 pin_mismatch_counts[testIt]++;
1064
1065 if( !pin_mismatch_counts.contains( refIt ) )
1066 pin_mismatch_counts.emplace( refIt, 1 );
1067 else
1068 pin_mismatch_counts[refIt]++;
1069 }
1070 }
1071 }
1072 }
1073
1074 std::multimap<size_t, iterator_t, std::greater<size_t>> pins_dsc;
1075
1076 std::transform( pin_mismatch_counts.begin(), pin_mismatch_counts.end(),
1077 std::inserter( pins_dsc, pins_dsc.begin() ),
1078 []( const auto& p )
1079 {
1080 return std::pair<size_t, iterator_t>( p.second, p.first );
1081 } );
1082
1083 for( const auto& [amount, pinItBind] : pins_dsc )
1084 {
1085 auto& pinIt = pinItBind;
1086
1087 if( pin_mismatches.empty() )
1088 break;
1089
1090 SCH_PIN* pin = ( *pinIt ).Pin();
1091 VECTOR2I position = pin->GetPosition();
1092
1093 iterator_t nearest_pin = pins.end();
1094 double smallest_distance = std::numeric_limits<double>::infinity();
1095 PIN_ERROR erc;
1096
1097 std::erase_if(
1098 pin_mismatches,
1099 [&]( const auto& tuple )
1100 {
1101 iterator_t other;
1102
1103 if( pinIt == std::get<0>( tuple ) )
1104 other = std::get<1>( tuple );
1105 else if( pinIt == std::get<1>( tuple ) )
1106 other = std::get<0>( tuple );
1107 else
1108 return false;
1109
1110 if( ( *pinIt ).Sheet().Cmp( ( *other ).Sheet() ) != 0 )
1111 {
1112 if( std::isinf( smallest_distance ) )
1113 {
1114 nearest_pin = other;
1115 erc = std::get<2>( tuple );
1116 }
1117 }
1118 else
1119 {
1120 double distance = position.Distance( ( *other ).Pin()->GetPosition() );
1121
1122 if( std::isinf( smallest_distance ) || distance < smallest_distance )
1123 {
1124 smallest_distance = distance;
1125 nearest_pin = other;
1126 erc = std::get<2>( tuple );
1127 }
1128 }
1129
1130 return true;
1131 } );
1132
1133 if( nearest_pin != pins.end() )
1134 {
1135 SCH_PIN* other_pin = ( *nearest_pin ).Pin();
1136
1137 std::shared_ptr<ERC_ITEM> ercItem =
1138 ERC_ITEM::Create( erc == PIN_ERROR::WARNING ? ERCE_PIN_TO_PIN_WARNING
1140 ercItem->SetItems( pin, other_pin );
1141 ercItem->SetSheetSpecificPath( ( *pinIt ).Sheet() );
1142 ercItem->SetItemsSheetPaths( ( *pinIt ).Sheet(), ( *nearest_pin ).Sheet() );
1143
1144 ercItem->SetErrorMessage(
1145 wxString::Format( _( "Pins of type %s and %s are connected" ),
1146 ElectricalPinTypeGetText( pin->GetType() ),
1147 ElectricalPinTypeGetText( other_pin->GetType() ) ) );
1148
1149 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), pin->GetPosition() );
1150 pinToScreenMap[pin]->Append( marker );
1151 errors++;
1152 }
1153 }
1154
1155 if( needsDriver.Pin() && !hasDriver && !has_noconnect )
1156 {
1157 int err_code = ispowerNet ? ERCE_POWERPIN_NOT_DRIVEN : ERCE_PIN_NOT_DRIVEN;
1158
1159 if( m_settings.IsTestEnabled( err_code ) )
1160 {
1161 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( err_code );
1162
1163 ercItem->SetItems( needsDriver.Pin() );
1164 ercItem->SetSheetSpecificPath( needsDriver.Sheet() );
1165 ercItem->SetItemsSheetPaths( needsDriver.Sheet() );
1166
1167 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ),
1168 needsDriver.Pin()->GetPosition() );
1169 pinToScreenMap[needsDriver.Pin()]->Append( marker );
1170 errors++;
1171 }
1172 }
1173 }
1174
1175 return errors;
1176}
1177
1178
1180{
1181 int errors = 0;
1182
1183 std::unordered_map<wxString, std::pair<wxString, SCH_PIN*>> pinToNetMap;
1184
1185 for( const std::pair<NET_NAME_CODE_CACHE_KEY, std::vector<CONNECTION_SUBGRAPH*>> net : m_nets )
1186 {
1187 const wxString& netName = net.first.Name;
1188
1189 for( CONNECTION_SUBGRAPH* subgraph : net.second )
1190 {
1191 for( SCH_ITEM* item : subgraph->GetItems() )
1192 {
1193 if( item->Type() == SCH_PIN_T )
1194 {
1195 SCH_PIN* pin = static_cast<SCH_PIN*>( item );
1196 const SCH_SHEET_PATH& sheet = subgraph->GetSheet();
1197
1198 if( !pin->GetLibPin()->GetParentSymbol()->IsMulti() )
1199 continue;
1200
1201 wxString name = pin->GetParentSymbol()->GetRef( &sheet ) +
1202 + ":" + pin->GetShownNumber();
1203
1204 if( !pinToNetMap.count( name ) )
1205 {
1206 pinToNetMap[name] = std::make_pair( netName, pin );
1207 }
1208 else if( pinToNetMap[name].first != netName )
1209 {
1210 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_DIFFERENT_UNIT_NET );
1211
1212 ercItem->SetErrorMessage( wxString::Format( _( "Pin %s is connected to both %s and %s" ),
1213 pin->GetShownNumber(),
1214 netName,
1215 pinToNetMap[name].first ) );
1216
1217 ercItem->SetItems( pin, pinToNetMap[name].second );
1218 ercItem->SetSheetSpecificPath( sheet );
1219 ercItem->SetItemsSheetPaths( sheet, sheet );
1220
1221 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), pin->GetPosition() );
1222 sheet.LastScreen()->Append( marker );
1223 errors += 1;
1224 }
1225 }
1226 }
1227 }
1228 }
1229
1230 return errors;
1231}
1232
1233
1235{
1236 int errCount = 0;
1237
1238 std::unordered_map<wxString, std::pair<SCH_ITEM*, SCH_SHEET_PATH>> globalLabels;
1239 std::unordered_map<wxString, std::pair<SCH_ITEM*, SCH_SHEET_PATH>> localLabels;
1240
1241 for( const std::pair<NET_NAME_CODE_CACHE_KEY, std::vector<CONNECTION_SUBGRAPH*>> net : m_nets )
1242 {
1243 for( CONNECTION_SUBGRAPH* subgraph : net.second )
1244 {
1245 const SCH_SHEET_PATH& sheet = subgraph->GetSheet();
1246
1247 for( SCH_ITEM* item : subgraph->GetItems() )
1248 {
1249 if( item->Type() == SCH_LABEL_T || item->Type() == SCH_GLOBAL_LABEL_T )
1250 {
1251 SCH_LABEL_BASE* label = static_cast<SCH_LABEL_BASE*>( item );
1252 wxString text = label->GetShownText( &sheet, false );
1253
1254 auto& map = item->Type() == SCH_LABEL_T ? localLabels : globalLabels;
1255
1256 if( !map.count( text ) )
1257 {
1258 map[text] = std::make_pair( label, sheet );
1259 }
1260 }
1261 }
1262 }
1263 }
1264
1265 for( auto& [globalText, globalItem] : globalLabels )
1266 {
1267 for( auto& [localText, localItem] : localLabels )
1268 {
1269 if( globalText == localText )
1270 {
1271 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_SAME_LOCAL_GLOBAL_LABEL );
1272 ercItem->SetItems( globalItem.first, localItem.first );
1273 ercItem->SetSheetSpecificPath( globalItem.second );
1274 ercItem->SetItemsSheetPaths( globalItem.second, localItem.second );
1275
1276 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ),
1277 globalItem.first->GetPosition() );
1278 globalItem.second.LastScreen()->Append( marker );
1279
1280 errCount++;
1281 }
1282 }
1283 }
1284
1285 return errCount;
1286}
1287
1288
1290{
1291 int errors = 0;
1292 std::unordered_map<wxString, std::vector<std::tuple<wxString, SCH_ITEM*, SCH_SHEET_PATH>>> generalMap;
1293
1294 auto logError = [&]( const wxString& normalized, SCH_ITEM* item, const SCH_SHEET_PATH& sheet,
1295 const std::tuple<wxString, SCH_ITEM*, SCH_SHEET_PATH>& other )
1296 {
1297 auto& [otherText, otherItem, otherSheet] = other;
1298 ERCE_T typeOfWarning = ERCE_SIMILAR_LABELS;
1299
1300 if( item->Type() == SCH_PIN_T && otherItem->Type() == SCH_PIN_T )
1301 {
1302 //Two Pins
1303 typeOfWarning = ERCE_SIMILAR_POWER;
1304 }
1305 else if( item->Type() == SCH_PIN_T || otherItem->Type() == SCH_PIN_T )
1306 {
1307 //Pin and Label
1308 typeOfWarning = ERCE_SIMILAR_LABEL_AND_POWER;
1309 }
1310 else
1311 {
1312 //Two Labels
1313 typeOfWarning = ERCE_SIMILAR_LABELS;
1314 }
1315
1316 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( typeOfWarning );
1317 ercItem->SetItems( item, otherItem );
1318 ercItem->SetSheetSpecificPath( sheet );
1319 ercItem->SetItemsSheetPaths( sheet, otherSheet );
1320
1321 SCH_MARKER* marker = new SCH_MARKER( std::move( ercItem ), item->GetPosition() );
1322 sheet.LastScreen()->Append( marker );
1323 };
1324
1325 for( const std::pair<NET_NAME_CODE_CACHE_KEY, std::vector<CONNECTION_SUBGRAPH*>> net : m_nets )
1326 {
1327 for( CONNECTION_SUBGRAPH* subgraph : net.second )
1328 {
1329 const SCH_SHEET_PATH& sheet = subgraph->GetSheet();
1330
1331 for( SCH_ITEM* item : subgraph->GetItems() )
1332 {
1333 switch( item->Type() )
1334 {
1335 case SCH_LABEL_T:
1336 case SCH_HIER_LABEL_T:
1337 case SCH_GLOBAL_LABEL_T:
1338 {
1339 SCH_LABEL_BASE* label = static_cast<SCH_LABEL_BASE*>( item );
1340 wxString unnormalized = label->GetShownText( &sheet, false );
1341 wxString normalized = unnormalized.Lower();
1342
1343 generalMap[normalized].emplace_back( std::make_tuple( unnormalized, label, sheet ) );
1344
1345 for( const auto& otherTuple : generalMap.at( normalized ) )
1346 {
1347 const auto& [otherText, otherItem, otherSheet] = otherTuple;
1348
1349 if( unnormalized != otherText )
1350 {
1351 logError( normalized, label, sheet, otherTuple );
1352 errors += 1;
1353 }
1354 }
1355
1356 break;
1357 }
1358 case SCH_PIN_T:
1359 {
1360 SCH_PIN* pin = static_cast<SCH_PIN*>( item );
1361
1362 if( !pin->IsPower() )
1363 {
1364 continue;
1365 }
1366
1367 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( pin->GetParentSymbol() );
1368 wxString unnormalized = symbol->GetValue( true, &sheet, false );
1369 wxString normalized = unnormalized.Lower();
1370
1371 generalMap[normalized].emplace_back( std::make_tuple( unnormalized, pin, sheet ) );
1372
1373 for( const auto& otherTuple : generalMap.at( normalized ) )
1374 {
1375 const auto& [otherText, otherItem, otherSheet] = otherTuple;
1376
1377 if( unnormalized != otherText )
1378 {
1379 logError( normalized, pin, sheet, otherTuple );
1380 errors += 1;
1381 }
1382 }
1383
1384 break;
1385 }
1386
1387 default:
1388 break;
1389 }
1390 }
1391 }
1392 }
1393 return errors;
1394}
1395
1396
1398{
1399 wxCHECK( m_schematic, 0 );
1400
1402 wxString msg;
1403 int err_count = 0;
1404
1405 for( SCH_SCREEN* screen = m_screens.GetFirst(); screen; screen = m_screens.GetNext() )
1406 {
1407 std::vector<SCH_MARKER*> markers;
1408
1409 for( SCH_ITEM* item : screen->Items().OfType( SCH_SYMBOL_T ) )
1410 {
1411 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
1412 LIB_SYMBOL* libSymbolInSchematic = symbol->GetLibSymbolRef().get();
1413
1414 if( !libSymbolInSchematic )
1415 continue;
1416
1417 wxString libName = symbol->GetLibId().GetLibNickname();
1418 const LIB_TABLE_ROW* libTableRow = libTable->FindRow( libName, true );
1419
1420 if( !libTableRow )
1421 {
1423 {
1424 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_LIB_SYMBOL_ISSUES );
1425 ercItem->SetItems( symbol );
1426 msg.Printf( _( "The current configuration does not include the symbol library '%s'" ),
1427 UnescapeString( libName ) );
1428 ercItem->SetErrorMessage( msg );
1429
1430 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1431 }
1432
1433 continue;
1434 }
1435 else if( !libTable->HasLibrary( libName, true ) )
1436 {
1438 {
1439 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_LIB_SYMBOL_ISSUES );
1440 ercItem->SetItems( symbol );
1441 msg.Printf( _( "The symbol library '%s' is not enabled in the current configuration" ),
1442 UnescapeString( libName ) );
1443 ercItem->SetErrorMessage( msg );
1444
1445 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1446 }
1447
1448 continue;
1449 }
1450 else if( !libTableRow->LibraryExists() )
1451 {
1453 {
1454 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_LIB_SYMBOL_ISSUES );
1455 ercItem->SetItems( symbol );
1456 msg.Printf( _( "The symbol library '%s' was not found at '%s'." ),
1457 UnescapeString( libName ),
1458 libTableRow->GetFullURI( true ) );
1459 ercItem->SetErrorMessage( msg );
1460
1461 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1462 }
1463
1464 continue;
1465 }
1466
1467 wxString symbolName = symbol->GetLibId().GetLibItemName();
1468 LIB_SYMBOL* libSymbol = SchGetLibSymbol( symbol->GetLibId(), libTable );
1469
1470 if( libSymbol == nullptr )
1471 {
1473 {
1474 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_LIB_SYMBOL_ISSUES );
1475 ercItem->SetItems( symbol );
1476 msg.Printf( _( "Symbol '%s' not found in symbol library '%s'" ),
1477 UnescapeString( symbolName ),
1478 UnescapeString( libName ) );
1479 ercItem->SetErrorMessage( msg );
1480
1481 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1482 }
1483
1484 continue;
1485 }
1486
1487 std::unique_ptr<LIB_SYMBOL> flattenedSymbol = libSymbol->Flatten();
1489
1491 {
1492 // We have to check for duplicate pins first as they will cause Compare() to fail.
1493 std::vector<wxString> messages;
1494 UNITS_PROVIDER unitsProvider( schIUScale, EDA_UNITS::MILS );
1495 CheckDuplicatePins( libSymbolInSchematic, messages, &unitsProvider );
1496
1497 if( !messages.empty() )
1498 {
1499 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_DUPLICATE_PIN_ERROR );
1500 ercItem->SetItems( symbol );
1501 msg.Printf( _( "Symbol '%s' has multiple pins with the same pin number" ),
1502 UnescapeString( symbolName ) );
1503 ercItem->SetErrorMessage( msg );
1504
1505 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1506 }
1507 else if( flattenedSymbol->Compare( *libSymbolInSchematic, flags ) != 0 )
1508 {
1509 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_LIB_SYMBOL_MISMATCH );
1510 ercItem->SetItems( symbol );
1511 msg.Printf( _( "Symbol '%s' doesn't match copy in library '%s'" ),
1512 UnescapeString( symbolName ),
1513 UnescapeString( libName ) );
1514 ercItem->SetErrorMessage( msg );
1515
1516 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1517 }
1518 }
1519 }
1520
1521 for( SCH_MARKER* marker : markers )
1522 {
1523 screen->Append( marker );
1524 err_count += 1;
1525 }
1526 }
1527
1528 return err_count;
1529}
1530
1531
1533{
1534 wxCHECK( m_schematic, 0 );
1535
1536 wxString msg;
1537 int err_count = 0;
1538
1539 typedef int (*TESTER_FN_PTR)( const wxString&, PROJECT* );
1540
1541 TESTER_FN_PTR linkTester = (TESTER_FN_PTR) aCvPcb->IfaceOrAddress( KIFACE_TEST_FOOTPRINT_LINK );
1542
1543 for( SCH_SHEET_PATH& sheet : m_sheetList )
1544 {
1545 std::vector<SCH_MARKER*> markers;
1546
1547 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
1548 {
1549 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
1550 wxString footprint = symbol->GetFootprintFieldText( true, &sheet, false );
1551
1552 if( footprint.IsEmpty() )
1553 continue;
1554
1555 LIB_ID fpID;
1556
1557 if( fpID.Parse( footprint, true ) >= 0 )
1558 {
1559 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_FOOTPRINT_LINK_ISSUES );
1560 msg.Printf( _( "'%s' is not a valid footprint identifier." ), footprint );
1561 ercItem->SetErrorMessage( msg );
1562 ercItem->SetItems( symbol );
1563 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1564 continue;
1565 }
1566
1567 wxString libName = fpID.GetLibNickname();
1568 wxString fpName = fpID.GetLibItemName();
1569 int ret = (linkTester)( footprint, aProject );
1570
1572 {
1573 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_FOOTPRINT_LINK_ISSUES );
1574 msg.Printf( _( "The current configuration does not include the footprint library '%s'." ),
1575 libName );
1576 ercItem->SetErrorMessage( msg );
1577 ercItem->SetItems( symbol );
1578 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1579 }
1581 {
1582 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_FOOTPRINT_LINK_ISSUES );
1583 msg.Printf( _( "The footprint library '%s' is not enabled in the current configuration." ),
1584 libName );
1585 ercItem->SetErrorMessage( msg );
1586 ercItem->SetItems( symbol );
1587 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1588 }
1590 {
1591 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_FOOTPRINT_LINK_ISSUES );
1592 msg.Printf( _( "Footprint '%s' not found in library '%s'." ),
1593 fpName,
1594 libName );
1595 ercItem->SetErrorMessage( msg );
1596 ercItem->SetItems( symbol );
1597 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1598 }
1599 }
1600
1601 for( SCH_MARKER* marker : markers )
1602 {
1603 sheet.LastScreen()->Append( marker );
1604 err_count += 1;
1605 }
1606 }
1607
1608 return err_count;
1609}
1610
1611
1613{
1614 wxCHECK( m_schematic, 0 );
1615
1616 wxString msg;
1617 int err_count = 0;
1618
1619 for( SCH_SHEET_PATH& sheet : m_sheetList )
1620 {
1621 std::vector<SCH_MARKER*> markers;
1622
1623 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
1624 {
1625 SCH_SYMBOL* sch_symbol = static_cast<SCH_SYMBOL*>( item );
1626 std::unique_ptr<LIB_SYMBOL>& lib_symbol = sch_symbol->GetLibSymbolRef();
1627
1628 if( !lib_symbol )
1629 continue;
1630
1631 wxArrayString filters = lib_symbol->GetFPFilters();
1632
1633 if( filters.empty() )
1634 continue;
1635
1636 wxString lowerId = sch_symbol->GetFootprintFieldText( true, &sheet, false ).Lower();
1637 LIB_ID footprint;
1638
1639 if( footprint.Parse( lowerId ) > 0 )
1640 continue;
1641
1642 wxString lowerItemName = footprint.GetUniStringLibItemName().Lower();
1643 bool found = false;
1644
1645 for( wxString filter : filters )
1646 {
1647 filter.LowerCase();
1648
1649 // If the filter contains a ':' character, include the library name in the pattern
1650 if( filter.Contains( wxS( ":" ) ) )
1651 found |= lowerId.Matches( filter );
1652 else
1653 found |= lowerItemName.Matches( filter );
1654
1655 if( found )
1656 break;
1657 }
1658
1659 if( !found )
1660 {
1661 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_FOOTPRINT_LINK_ISSUES );
1662 msg.Printf( _( "Assigned footprint (%s) doesn't match footprint filters (%s)." ),
1663 footprint.GetUniStringLibItemName(),
1664 wxJoin( filters, ' ' ) );
1665 ercItem->SetErrorMessage( msg );
1666 ercItem->SetItems( sch_symbol );
1667 markers.emplace_back( new SCH_MARKER( std::move( ercItem ),
1668 sch_symbol->GetPosition() ) );
1669 }
1670 }
1671
1672 for( SCH_MARKER* marker : markers )
1673 {
1674 sheet.LastScreen()->Append( marker );
1675 err_count += 1;
1676 }
1677 }
1678
1679 return err_count;
1680}
1681
1682
1684{
1685 const int gridSize = m_schematic->Settings().m_ConnectionGridSize;
1686 int err_count = 0;
1687
1688 for( SCH_SCREEN* screen = m_screens.GetFirst(); screen; screen = m_screens.GetNext() )
1689 {
1690 std::vector<SCH_MARKER*> markers;
1691
1692 for( SCH_ITEM* item : screen->Items() )
1693 {
1694 if( item->Type() == SCH_LINE_T && item->IsConnectable() )
1695 {
1696 SCH_LINE* line = static_cast<SCH_LINE*>( item );
1697
1698 if( ( line->GetStartPoint().x % gridSize ) != 0
1699 || ( line->GetStartPoint().y % gridSize ) != 0 )
1700 {
1701 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_ENDPOINT_OFF_GRID );
1702 ercItem->SetItems( line );
1703
1704 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), line->GetStartPoint() ) );
1705 }
1706 else if( ( line->GetEndPoint().x % gridSize ) != 0
1707 || ( line->GetEndPoint().y % gridSize ) != 0 )
1708 {
1709 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_ENDPOINT_OFF_GRID );
1710 ercItem->SetItems( line );
1711
1712 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), line->GetEndPoint() ) );
1713 }
1714 }
1715 if( item->Type() == SCH_BUS_WIRE_ENTRY_T )
1716 {
1717 SCH_BUS_WIRE_ENTRY* entry = static_cast<SCH_BUS_WIRE_ENTRY*>( item );
1718
1719 for( const VECTOR2I& point : entry->GetConnectionPoints() )
1720 {
1721 if( ( point.x % gridSize ) != 0
1722 || ( point.y % gridSize ) != 0 )
1723 {
1724 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_ENDPOINT_OFF_GRID );
1725 ercItem->SetItems( entry );
1726
1727 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), point ) );
1728 }
1729 }
1730 }
1731 else if( item->Type() == SCH_SYMBOL_T )
1732 {
1733 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
1734
1735 for( SCH_PIN* pin : symbol->GetPins( nullptr ) )
1736 {
1737 if( pin->GetType() == ELECTRICAL_PINTYPE::PT_NC )
1738 continue;
1739
1740 VECTOR2I pinPos = pin->GetPosition();
1741
1742 if( ( pinPos.x % gridSize ) != 0 || ( pinPos.y % gridSize ) != 0 )
1743 {
1744 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_ENDPOINT_OFF_GRID );
1745 ercItem->SetItems( pin );
1746
1747 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), pinPos ) );
1748 break;
1749 }
1750 }
1751 }
1752 }
1753
1754 for( SCH_MARKER* marker : markers )
1755 {
1756 screen->Append( marker );
1757 err_count += 1;
1758 }
1759 }
1760
1761 return err_count;
1762}
1763
1764
1766{
1767 WX_STRING_REPORTER reporter;
1768 int err_count = 0;
1769 SIM_LIB_MGR libMgr( &m_schematic->Prj() );
1770
1771 for( SCH_SHEET_PATH& sheet : m_sheetList )
1772 {
1773 if( sheet.GetExcludedFromSim() )
1774 continue;
1775
1776 std::vector<SCH_MARKER*> markers;
1777
1778 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
1779 {
1780 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
1781
1782 // Power symbols and other symbols which have the reference starting with "#" are
1783 // not included in simulation
1784 if( symbol->GetRef( &sheet ).StartsWith( '#' ) || symbol->ResolveExcludedFromSim() )
1785 continue;
1786
1787 // Reset for each symbol
1788 reporter.Clear();
1789
1790 SIM_LIBRARY::MODEL model = libMgr.CreateModel( &sheet, *symbol, true, 0, reporter );
1791
1792 if( reporter.HasMessage() )
1793 {
1794 wxString msg = reporter.GetMessages();
1795 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_SIMULATION_MODEL );
1796
1797 //Remove \n and \r at e.o.l if any:
1798 msg.Trim();
1799
1800 ercItem->SetErrorMessage( msg );
1801 ercItem->SetItems( symbol );
1802
1803 markers.emplace_back( new SCH_MARKER( std::move( ercItem ), symbol->GetPosition() ) );
1804 }
1805 }
1806
1807 for( SCH_MARKER* marker : markers )
1808 {
1809 sheet.LastScreen()->Append( marker );
1810 err_count += 1;
1811 }
1812 }
1813
1814 return err_count;
1815}
1816
1817
1819 KIFACE* aCvPcb, PROJECT* aProject, PROGRESS_REPORTER* aProgressReporter )
1820{
1822
1823 // Test duplicate sheet names inside a given sheet. While one can have multiple references
1824 // to the same file, each must have a unique name.
1826 {
1827 if( aProgressReporter )
1828 aProgressReporter->AdvancePhase( _( "Checking sheet names..." ) );
1829
1831 }
1832
1834 {
1835 if( aProgressReporter )
1836 aProgressReporter->AdvancePhase( _( "Checking bus conflicts..." ) );
1837
1839 }
1840
1841 // The connection graph has a whole set of ERC checks it can run
1842 if( aProgressReporter )
1843 aProgressReporter->AdvancePhase( _( "Checking conflicts..." ) );
1844
1845 // If we are using the new connectivity, make sure that we do a full-rebuild
1846 if( aEditFrame )
1847 {
1848 if( ADVANCED_CFG::GetCfg().m_IncrementalConnectivity )
1849 aEditFrame->RecalculateConnections( nullptr, GLOBAL_CLEANUP );
1850 else
1851 aEditFrame->RecalculateConnections( nullptr, NO_CLEANUP );
1852 }
1853
1855
1856 if( aProgressReporter )
1857 aProgressReporter->AdvancePhase( _( "Checking units..." ) );
1858
1859 // Test is all units of each multiunit symbol have the same footprint assigned.
1861 {
1862 if( aProgressReporter )
1863 aProgressReporter->AdvancePhase( _( "Checking footprints..." ) );
1864
1866 }
1867
1872 {
1874 }
1875
1876 if( aProgressReporter )
1877 aProgressReporter->AdvancePhase( _( "Checking pins..." ) );
1878
1881
1882 // Test pins on each net against the pin connection table
1886 {
1887 TestPinToPin();
1888 }
1889
1890 // Test similar labels (i;e. labels which are identical when
1891 // using case insensitive comparisons)
1895 {
1896 if( aProgressReporter )
1897 aProgressReporter->AdvancePhase( _( "Checking similar labels..." ) );
1898
1900 }
1901
1903 {
1904 if( aProgressReporter )
1905 aProgressReporter->AdvancePhase( _( "Checking local and global labels..." ) );
1906
1908 }
1909
1911 {
1912 if( aProgressReporter )
1913 aProgressReporter->AdvancePhase( _( "Checking for unresolved variables..." ) );
1914
1915 TestTextVars( aDrawingSheet );
1916 }
1917
1919 {
1920 if( aProgressReporter )
1921 aProgressReporter->AdvancePhase( _( "Checking SPICE models..." ) );
1922
1924 }
1925
1927 {
1928 if( aProgressReporter )
1929 aProgressReporter->AdvancePhase( _( "Checking no connect pins for connections..." ) );
1930
1932 }
1933
1936 {
1937 if( aProgressReporter )
1938 aProgressReporter->AdvancePhase( _( "Checking for library symbol issues..." ) );
1939
1941 }
1942
1944 {
1945 if( aProgressReporter )
1946 aProgressReporter->AdvancePhase( _( "Checking for footprint link issues..." ) );
1947
1948 TestFootprintLinkIssues( aCvPcb, aProject );
1949 }
1950
1952 {
1953 if( aProgressReporter )
1954 aProgressReporter->AdvancePhase( _( "Checking footprint assignments against footprint filters..." ) );
1955
1957 }
1958
1960 {
1961 if( aProgressReporter )
1962 aProgressReporter->AdvancePhase( _( "Checking for off grid pins and wires..." ) );
1963
1965 }
1966
1968 {
1969 if( aProgressReporter )
1970 aProgressReporter->AdvancePhase( _( "Checking for four way junctions..." ) );
1971
1973 }
1974
1976 {
1977 if( aProgressReporter )
1978 aProgressReporter->AdvancePhase( _( "Checking for labels on more than one wire..." ) );
1979
1981 }
1982
1984 {
1985 if( aProgressReporter )
1986 aProgressReporter->AdvancePhase( _( "Checking for undefined netclasses..." ) );
1987
1989 }
1990
1992}
const char * name
Definition: DXF_plotter.cpp:62
constexpr EDA_IU_SCALE schIUScale
Definition: base_units.h:114
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
int RunERC()
Run electrical rule checks on the connectivity graph.
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.
Definition: ds_draw_item.h:59
Store the list of graphic items: rect, lines, polygons and texts to draw/plot the title block and fra...
Definition: ds_draw_item.h:401
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.
Definition: ds_draw_item.h:445
void SetSheetName(const wxString &aSheetName)
Set the sheet name to draw/plot.
Definition: ds_draw_item.h:450
void SetSheetLayer(const wxString &aSheetLayer)
Set the sheet layer to draw/plot.
Definition: ds_draw_item.h:460
void SetSheetCount(int aSheetCount)
Set the value of the count of sheets, for basic inscriptions.
Definition: ds_draw_item.h:499
void SetPageNumber(const wxString &aPageNumber)
Set the value of the sheet number.
Definition: ds_draw_item.h:489
void SetProject(const PROJECT *aProject)
Definition: ds_draw_item.h:425
A graphic text.
Definition: ds_draw_item.h:313
const PAGE_INFO & GetPageInfo()
const TITLE_BLOCK & GetTitleBlock()
virtual VECTOR2I GetPosition() const
Definition: eda_item.h:259
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:109
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:297
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.
bool IsTestEnabled(int aErrorCode) const
Definition: erc_settings.h:148
ERC_PIN_SORTING_METRIC GetERCSortingMetric() const
Get the type of sorting metric the ERC checker should use to resolve multi-pin errors.
Definition: erc_settings.h:175
PIN_ERROR GetPinMapValue(int aFirstType, int aSecondType) const
Definition: erc_settings.h:177
int GetPinTypeWeight(ELECTRICAL_PINTYPE aPinType) const
Get the weight for an electrical pin type.
Definition: erc_settings.h:165
int TestLibSymbolIssues()
Test symbols for changed library symbols and broken symbol library links.
Definition: erc.cpp:1397
const NET_MAP & m_nets
Definition: erc.h:191
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:939
int TestSimilarLabels()
Checks for labels that differ only in capitalization.
Definition: erc.cpp:1289
SCH_MULTI_UNIT_REFERENCE_MAP m_refMap
Definition: erc.h:190
SCH_SCREENS m_screens
Definition: erc.h:189
int TestFootprintLinkIssues(KIFACE *aCvPcb, PROJECT *aProject)
Test footprint links against the current footprint libraries.
Definition: erc.cpp:1532
int TestOffGridEndpoints()
Test pins and wire ends for being off grid.
Definition: erc.cpp:1683
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:1234
int TestMultUnitPinConflicts()
Checks if shared pins on multi-unit symbols have been connected to different nets.
Definition: erc.cpp:1179
int TestConflictingBusAliases()
Check that there are no conflicting bus alias definitions in the schematic.
Definition: erc.cpp:439
int TestNoConnectPins()
In KiCad 5 and earlier, you could connect stuff up to pins with NC electrical type.
Definition: erc.cpp:870
int TestFootprintFilters()
Test symbols to ensure that assigned footprint passes any given footprint filters.
Definition: erc.cpp:1612
ERC_SETTINGS & m_settings
Definition: erc.h:187
int TestFourWayJunction()
Test to see if there are potentially confusing 4-way junctions in the schematic.
Definition: erc.cpp:791
int TestMissingNetclasses()
Tests for netclasses that are referenced but not defined.
Definition: erc.cpp:682
int TestSimModelIssues()
Test SPICE models for various issues.
Definition: erc.cpp:1765
SCH_SHEET_LIST m_sheetList
Definition: erc.h:188
SCHEMATIC * m_schematic
Definition: erc.h:186
void RunTests(DS_PROXY_VIEW_ITEM *aDrawingSheet, SCH_EDIT_FRAME *aEditFrame, KIFACE *aCvPcb, PROJECT *aProject, PROGRESS_REPORTER *aProgressReporter)
Definition: erc.cpp:1818
int TestMissingUnits()
Test for uninstantiated units of multi unit symbols.
Definition: erc.cpp:545
int TestLabelMultipleWires()
Test to see if there are labels that are connected to more than one wire.
Definition: erc.cpp:736
int TestMultiunitFootprints()
Test if all units of each multiunit symbol have the same footprint assigned.
Definition: erc.cpp:484
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:85
std::vector< SCH_PIN * > GetPins(int aUnit, int aBodyStyle) const
Return a list of pin object pointers from the draw item list.
Definition: lib_symbol.cpp:800
wxString GetUnitDisplayName(int aUnit) override
Return the user-defined display name for aUnit for symbols with units.
Definition: lib_symbol.cpp:301
int GetUnitCount() const override
std::unique_ptr< LIB_SYMBOL > Flatten() const
Return a flattened symbol inheritance to the caller.
Definition: lib_symbol.cpp:345
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.
std::shared_ptr< NET_SETTINGS > & NetSettings()
Definition: project_file.h:105
static SYMBOL_LIB_TABLE * SchSymbolLibTable(PROJECT *aProject)
Accessor for project symbol library table.
Container for project specific data.
Definition: project.h:65
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:204
PROJECT & Prj() const
Return a reference to the project this schematic is part of.
Definition: schematic.h:102
void ResolveERCExclusionsPostUpdate()
Update markers to match recorded exclusions.
Definition: schematic.cpp:871
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:317
CONNECTION_GRAPH * ConnectionGraph() const
Definition: schematic.h:182
std::vector< VECTOR2I > GetConnectionPoints() const override
Add all the connection points for this item to aPoints.
Class for a wire to bus entry.
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.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:168
int GetBodyStyle() const
Definition: sch_item.h:246
@ EQUALITY
Definition: sch_item.h:666
bool ResolveExcludedFromSim() const
Definition: sch_item.cpp:242
wxString GetShownText(const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const override
Definition: sch_label.cpp:878
std::vector< VECTOR2I > GetConnectionPoints() const override
Add all the connection points for this item to aPoints.
Definition: sch_label.cpp:990
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:685
VECTOR2I GetEndPoint() const
Definition: sch_line.h:144
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:943
bool IsVisible() const
Definition: sch_pin.cpp:373
bool IsStacked(const SCH_PIN *aPin) const
Definition: sch_pin.cpp:453
ELECTRICAL_PINTYPE GetType() const
Definition: sch_pin.cpp:295
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
SCH_REFERENCE & GetItem(size_t aIdx)
size_t GetCount() const
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
int GetUnit() const
SCH_SCREEN * GetNext()
SCH_SCREEN * GetFirst()
void Append(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
Definition: sch_screen.cpp:160
EE_RTREE & Items()
Get the full RTree, usually for iterating.
Definition: sch_screen.h:112
void AnnotatePowerSymbols()
Silently annotate the not yet annotated power symbols of the entire hierarchy of the sheet path list.
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.
Definition: sch_sheet_pin.h:66
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:415
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
Definition: sch_symbol.cpp:720
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly) const override
Populate a std::vector with SCH_FIELDs, sorted in ordinal order.
Definition: sch_symbol.cpp:780
const wxString GetFootprintFieldText(bool aResolve, const SCH_SHEET_PATH *aPath, bool aAllowExtraText) const
Definition: sch_symbol.cpp:736
VECTOR2I GetPosition() const override
Definition: sch_symbol.h:777
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
Definition: sch_symbol.cpp:550
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...
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:190
void Clear() override
Definition: reporter.cpp:89
bool HasMessage() const override
Returns true if the reporter client is non-empty.
Definition: reporter.cpp:96
const wxString & GetMessages() const
Definition: reporter.cpp:83
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)
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.
Definition: erc_settings.h:37
@ ERCE_POWERPIN_NOT_DRIVEN
Power input pin connected to some others pins but no power out pin to drive it.
Definition: erc_settings.h:45
@ ERCE_SIMILAR_POWER
2 power pins are equal for case insensitive comparisons.
Definition: erc_settings.h:52
@ ERCE_MISSING_POWER_INPUT_PIN
Symbol has power input pins that are not placed on the schematic.
Definition: erc_settings.h:58
@ ERCE_SIMILAR_LABELS
2 labels are equal for case insensitive comparisons.
Definition: erc_settings.h:51
@ ERCE_ENDPOINT_OFF_GRID
Pin or wire-end off grid.
Definition: erc_settings.h:41
@ ERCE_SAME_LOCAL_GLOBAL_LABEL
2 labels are equal for case insensitive comparisons.
Definition: erc_settings.h:55
@ ERCE_SIMILAR_LABEL_AND_POWER
label and pin are equal for case insensitive comparisons.
Definition: erc_settings.h:53
@ ERCE_FOOTPRINT_LINK_ISSUES
The footprint link is invalid, or points to a missing (or inactive) footprint or library.
Definition: erc_settings.h:79
@ ERCE_DUPLICATE_PIN_ERROR
Definition: erc_settings.h:93
@ ERCE_DIFFERENT_UNIT_NET
Shared pin in a multi-unit symbol is connected to more than one net.
Definition: erc_settings.h:63
@ ERCE_FOUR_WAY_JUNCTION
A four-way junction was found.
Definition: erc_settings.h:87
@ ERCE_UNDEFINED_NETCLASS
A netclass was referenced but not defined.
Definition: erc_settings.h:74
@ ERCE_UNRESOLVED_VARIABLE
A text variable could not be resolved.
Definition: erc_settings.h:73
@ ERCE_SIMULATION_MODEL
An error was found in the simulation model.
Definition: erc_settings.h:75
@ ERCE_LIB_SYMBOL_MISMATCH
Symbol doesn't match copy in library.
Definition: erc_settings.h:78
@ ERCE_GENERIC_ERROR
Definition: erc_settings.h:99
@ ERCE_DIFFERENT_UNIT_FP
Different units of the same symbol have different footprints assigned.
Definition: erc_settings.h:56
@ ERCE_NOCONNECT_CONNECTED
A no connect symbol is connected to more than 1 pin.
Definition: erc_settings.h:48
@ ERCE_PIN_TO_PIN_WARNING
Definition: erc_settings.h:94
@ ERCE_PIN_NOT_DRIVEN
Pin connected to some others pins but no pin to drive it.
Definition: erc_settings.h:43
@ ERCE_MISSING_INPUT_PIN
Symbol has input pins that are not placed.
Definition: erc_settings.h:60
@ ERCE_MISSING_UNIT
Symbol has units that are not placed on the schematic.
Definition: erc_settings.h:62
@ ERCE_DUPLICATE_SHEET_NAME
Duplicate sheet names within a given sheet.
Definition: erc_settings.h:40
@ ERCE_MISSING_BIDI_PIN
Symbol has bi-directional pins that are not placed.
Definition: erc_settings.h:61
@ ERCE_LIB_SYMBOL_ISSUES
Symbol not found in active libraries.
Definition: erc_settings.h:77
@ ERCE_FOOTPRINT_FILTERS
The assigned footprint doesn't match the footprint filters.
Definition: erc_settings.h:81
@ ERCE_BUS_ALIAS_CONFLICT
Conflicting bus alias definitions across sheets.
Definition: erc_settings.h:65
@ ERCE_GENERIC_WARNING
Definition: erc_settings.h:98
@ ERCE_LABEL_MULTIPLE_WIRES
A label is connected to more than one wire.
Definition: erc_settings.h:88
@ ERCE_PIN_TO_PIN_ERROR
Definition: erc_settings.h:95
PIN_ERROR
The values a pin-to-pin entry in the pin matrix can take on.
Definition: erc_settings.h:104
@ 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
wxString ElectricalPinTypeGetText(ELECTRICAL_PINTYPE aType)
Definition: pin_type.cpp:212
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
@ PT_OUTPUT
usual output
@ PT_TRISTATE
tri state bus pin
@ PT_BIDI
input or output (like port for a microprocessor)
@ PT_POWER_OUT
output of a regulator: intended to be connected to power input pins
@ PT_POWER_IN
power input (GND, VCC for ICs). Must be connected to a power output.
@ PT_PASSIVE
pin for passive symbols: must be connected, and can be connected to any pin.
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:74
@ GLOBAL_CLEANUP
Definition: schematic.h:76
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:164
@ SCH_NO_CONNECT_T
Definition: typeinfo.h:161
@ SCH_SYMBOL_T
Definition: typeinfo.h:173
@ SCH_FIELD_T
Definition: typeinfo.h:151
@ SCH_LABEL_T
Definition: typeinfo.h:168
@ SCH_LOCATE_ANY_T
Definition: typeinfo.h:200
@ SCH_SHEET_T
Definition: typeinfo.h:176
@ SCH_HIER_LABEL_T
Definition: typeinfo.h:170
@ SCH_TEXT_T
Definition: typeinfo.h:152
@ SCH_BUS_WIRE_ENTRY_T
Definition: typeinfo.h:162
@ SCH_TEXTBOX_T
Definition: typeinfo.h:153
@ SCH_GLOBAL_LABEL_T
Definition: typeinfo.h:169
@ SCH_PIN_T
Definition: typeinfo.h:154
VECTOR2< int32_t > VECTOR2I
Definition: vector2d.h:695