KiCad PCB EDA Suite
Loading...
Searching...
No Matches
erc_settings.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2020 CERN
5 * @author Jon Evans <[email protected]>
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#include <erc/erc_item.h>
22#include <erc/erc_settings.h>
23#include <schematic.h>
24#include <sch_marker.h>
25#include <sch_screen.h>
27#include <settings/parameters.h>
28
29
31
32
33
34#define OK PIN_ERROR::OK
35#define ERR PIN_ERROR::PP_ERROR
36#define WAR PIN_ERROR::WARNING
37
42{
43/* I, O, Bi, 3S, Pas, NIC, UnS, PwrI, PwrO, OC, OE, NC */
44/* I */ { OK, OK, OK, OK, OK, OK, WAR, OK, OK, OK, OK, ERR },
45/* O */ { OK, ERR, OK, WAR, OK, OK, WAR, OK, ERR, ERR, ERR, ERR },
46/* Bi */ { OK, OK, OK, OK, OK, OK, WAR, OK, WAR, OK, WAR, ERR },
47/* 3S */ { OK, WAR, OK, OK, OK, OK, WAR, WAR, ERR, WAR, WAR, ERR },
48/*Pas */ { OK, OK, OK, OK, OK, OK, WAR, OK, OK, OK, OK, ERR },
49/*NIC */ { OK, OK, OK, OK, OK, OK, OK, OK, OK, OK, OK, ERR },
50/*UnS */ { WAR, WAR, WAR, WAR, WAR, OK, WAR, WAR, WAR, WAR, WAR, ERR },
51/*PwrI*/ { OK, OK, OK, WAR, OK, OK, WAR, OK, OK, OK, OK, ERR },
52/*PwrO*/ { OK, ERR, WAR, ERR, OK, OK, WAR, OK, ERR, ERR, ERR, ERR },
53/* OC */ { OK, ERR, OK, WAR, OK, OK, WAR, OK, ERR, OK, OK, ERR },
54/* OE */ { OK, ERR, WAR, WAR, OK, OK, WAR, OK, ERR, OK, OK, ERR },
55/* NC */ { ERR, ERR, ERR, ERR, ERR, ERR, ERR, ERR, ERR, ERR, ERR, ERR }
56};
57
58
70{
71/* I, O, Bi, 3S, Pas, NIC, UnS, PwrI, PwrO, OC, OE, NC */
72/* I */ { NOD, DRV, DRV, DRV, DRV, NOD, DRV, NOD, DRV, DRV, DRV, NPI },
73/* O */ { DRV, DRV, DRV, DRV, DRV, NOD, DRV, DRV, DRV, DRV, DRV, NPI },
74/* Bi */ { DRV, DRV, DRV, DRV, DRV, NOD, DRV, NOD, DRV, DRV, DRV, NPI },
75/* 3S */ { DRV, DRV, DRV, DRV, DRV, NOD, DRV, NOD, DRV, DRV, DRV, NPI },
76/*Pas */ { DRV, DRV, DRV, DRV, DRV, NOD, DRV, NOD, DRV, DRV, DRV, NPI },
77/*NIC */ { NOD, NOD, NOD, NOD, NOD, NOD, NOD, NOD, NOD, NOD, NOD, NPI },
78/*UnS */ { DRV, DRV, DRV, DRV, DRV, NOD, DRV, NOD, DRV, DRV, DRV, NPI },
79/*PwrI*/ { NOD, DRV, NOD, NOD, NOD, NOD, NOD, NOD, DRV, NOD, NOD, NPI },
80/*PwrO*/ { DRV, DRV, DRV, DRV, DRV, NOD, DRV, DRV, DRV, DRV, DRV, NPI },
81/* OC */ { DRV, DRV, DRV, DRV, DRV, NOD, DRV, NOD, DRV, DRV, DRV, NPI },
82/* OE */ { DRV, DRV, DRV, DRV, DRV, NOD, DRV, NOD, DRV, DRV, DRV, NPI },
83/* NC */ { NPI, NPI, NPI, NPI, NPI, NPI, NPI, NPI, NPI, NPI, NPI, NPI }
84};
85
86
87ERC_SETTINGS::ERC_SETTINGS( JSON_SETTINGS* aParent, const std::string& aPath ) :
88 NESTED_SETTINGS( "erc", ercSettingsSchemaVersion, aParent, aPath )
89{
91
92 for( int i = ERCE_FIRST; i <= ERCE_LAST; ++i )
94
95 // Error is the default setting so set non-error priorities here.
114
115 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "rule_severities",
116 [&]() -> nlohmann::json
117 {
118 nlohmann::json ret = {};
119
120 for( const RC_ITEM& item : ERC_ITEM::GetItemsWithSeverities() )
121 {
122 wxString name = item.GetSettingsKey();
123 int code = item.GetErrorCode();
124
125 if( name.IsEmpty() || m_ERCSeverities.count( code ) == 0 )
126 continue;
127
128 ret[std::string( name.ToUTF8() )] = SeverityToString( m_ERCSeverities[code] );
129 }
130
131 return ret;
132 },
133 [&]( const nlohmann::json& aJson )
134 {
135 if( !aJson.is_object() )
136 return;
137
138 for( const RC_ITEM& item : ERC_ITEM::GetItemsWithSeverities() )
139 {
140 int code = item.GetErrorCode();
141 wxString name = item.GetSettingsKey();
142
143 std::string key( name.ToUTF8() );
144
145 if( aJson.contains( key ) )
146 m_ERCSeverities[code] = SeverityFromString( aJson[key] );
147 }
148 },
149 {} ) );
150
151 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "erc_exclusions",
152 [&]() -> nlohmann::json
153 {
154 nlohmann::json js = nlohmann::json::array();
155
156 for( const wxString& entry : m_ErcExclusions )
157 js.push_back( { entry, m_ErcExclusionComments[ entry ] } );
158
159 return js;
160 },
161 [&]( const nlohmann::json& aObj )
162 {
163 m_ErcExclusions.clear();
164
165 if( !aObj.is_array() )
166 return;
167
168 for( const nlohmann::json& entry : aObj )
169 {
170 if( entry.is_array() )
171 {
172 wxString serialized = entry[0].get<wxString>();
173 m_ErcExclusions.insert( serialized );
174 m_ErcExclusionComments[ serialized ] = entry[1].get<wxString>();
175 }
176 else if( entry.is_string() )
177 {
178 m_ErcExclusions.insert( entry.get<wxString>() );
179 }
180 }
181 },
182 {} ) );
183
184 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "pin_map",
185 [&]() -> nlohmann::json
186 {
187 nlohmann::json ret = nlohmann::json::array();
188
189 for( int i = 0; i < ELECTRICAL_PINTYPES_TOTAL; i++ )
190 {
191 nlohmann::json inner = nlohmann::json::array();
192
193 for( int j = 0; j < ELECTRICAL_PINTYPES_TOTAL; j++ )
194 inner.push_back( static_cast<int>( GetPinMapValue( i, j ) ) );
195
196 ret.push_back( inner );
197 }
198
199 return ret;
200 },
201 [&]( const nlohmann::json& aJson )
202 {
203 if( !aJson.is_array() || aJson.size() != ELECTRICAL_PINTYPES_TOTAL )
204 return;
205
206 for( size_t i = 0; i < ELECTRICAL_PINTYPES_TOTAL; i++ )
207 {
208 if( i > aJson.size() - 1 )
209 break;
210
211 nlohmann::json inner = aJson[i];
212
213 if( !inner.is_array() || inner.size() != ELECTRICAL_PINTYPES_TOTAL )
214 return;
215
216 for( size_t j = 0; j < ELECTRICAL_PINTYPES_TOTAL; j++ )
217 {
218 if( inner[j].is_number_integer() )
219 {
220 int val = inner[j].get<int>();
221
222 if( val >= 0 && val <= static_cast<int>( PIN_ERROR::UNCONNECTED ) )
223 SetPinMapValue( i, j, static_cast<PIN_ERROR>( val ) );
224 }
225 }
226 }
227 },
228 {} ) );
229}
230
231
233{
234 if( m_parent )
235 {
237 m_parent = nullptr;
238 }
239}
240
241
242SEVERITY ERC_SETTINGS::GetSeverity( int aErrorCode ) const
243{
244 // Special-case duplicate pin error. Unique pin names are required by KiCad, so this
245 // is always an error.
246 if( aErrorCode == ERCE_DUPLICATE_PIN_ERROR )
247 {
248 return RPT_SEVERITY_ERROR;
249 }
250 // Special-case pin-to-pin errors:
251 // Ignore-or-not is controlled by ERCE_PIN_TO_PIN_WARNING (for both)
252 // Warning-or-error is controlled by which errorCode it is
253 else if( aErrorCode == ERCE_PIN_TO_PIN_ERROR )
254 {
255 wxASSERT( m_ERCSeverities.count( ERCE_PIN_TO_PIN_WARNING ) );
256
258 return RPT_SEVERITY_IGNORE;
259 else
260 return RPT_SEVERITY_ERROR;
261 }
262 else if( aErrorCode == ERCE_PIN_TO_PIN_WARNING )
263 {
264 wxASSERT( m_ERCSeverities.count( ERCE_PIN_TO_PIN_WARNING ) );
265
267 return RPT_SEVERITY_IGNORE;
268 else
270 }
271
272 wxCHECK_MSG( m_ERCSeverities.count( aErrorCode ), RPT_SEVERITY_IGNORE,
273 wxS( "Missing severity from map in ERC_SETTINGS!" ) );
274
275 return m_ERCSeverities.at( aErrorCode );
276}
277
278
279void ERC_SETTINGS::SetSeverity( int aErrorCode, SEVERITY aSeverity )
280{
281 m_ERCSeverities[ aErrorCode ] = aSeverity;
282}
283
284
286{
287 memcpy( m_PinMap, m_defaultPinMap, sizeof( m_PinMap ) );
288}
289
290
291void SHEETLIST_ERC_ITEMS_PROVIDER::visitMarkers( std::function<void( SCH_MARKER* )> aVisitor ) const
292{
293 SCH_SHEET_LIST sheetList = m_schematic->GetSheets();
294
295 std::set<SCH_SCREEN*> seenScreens;
296
297 for( unsigned i = 0; i < sheetList.size(); i++ )
298 {
299 bool firstTime = seenScreens.count( sheetList[i].LastScreen() ) == 0;
300
301 if( firstTime )
302 seenScreens.insert( sheetList[i].LastScreen() );
303
304 for( SCH_ITEM* item : sheetList[i].LastScreen()->Items().OfType( SCH_MARKER_T ) )
305 {
306 SCH_MARKER* marker = static_cast<SCH_MARKER*>( item );
307
308 if( marker->GetMarkerType() != MARKER_BASE::MARKER_ERC )
309 continue;
310
311 std::shared_ptr<const ERC_ITEM> ercItem =
312 std::static_pointer_cast<const ERC_ITEM>( marker->GetRCItem() );
313
314 // Only show sheet-specific markers on the owning sheet
315 if( ercItem->IsSheetSpecific() )
316 {
317 if( ercItem->GetSpecificSheetPath() != sheetList[i] )
318 continue;
319 }
320
321 // Don't show non-specific markers more than once
322 if( !firstTime && !ercItem->IsSheetSpecific() )
323 continue;
324
325 aVisitor( marker );
326 }
327 }
328}
329
330
332{
333 m_severities = aSeverities;
334
335 m_filteredMarkers.clear();
336
337 ERC_SETTINGS& settings = m_schematic->ErcSettings();
338
340 [&]( SCH_MARKER* aMarker )
341 {
342 SEVERITY markerSeverity;
343
344 if( aMarker->IsExcluded() )
345 markerSeverity = RPT_SEVERITY_EXCLUSION;
346 else
347 markerSeverity = settings.GetSeverity( aMarker->GetRCItem()->GetErrorCode() );
348
349 if( markerSeverity & m_severities )
350 m_filteredMarkers.push_back( aMarker );
351 } );
352}
353
354
356{
357 if( aSeverity < 0 )
358 return m_filteredMarkers.size();
359
360 int count = 0;
361
362 const ERC_SETTINGS& settings = m_schematic->ErcSettings();
363
365 [&]( SCH_MARKER* aMarker )
366 {
367 SEVERITY markerSeverity;
368
369 if( aMarker->IsExcluded() )
370 markerSeverity = RPT_SEVERITY_EXCLUSION;
371 else
372 markerSeverity = settings.GetSeverity( aMarker->GetRCItem()->GetErrorCode() );
373
374 if( ( markerSeverity & aSeverity ) > 0 )
375 count++;
376 } );
377
378 return count;
379}
380
381
382std::shared_ptr<ERC_ITEM> SHEETLIST_ERC_ITEMS_PROVIDER::GetERCItem( int aIndex ) const
383{
384 SCH_MARKER* marker = m_filteredMarkers[ aIndex ];
385
386 return marker ? std::static_pointer_cast<ERC_ITEM>( marker->GetRCItem() ) : nullptr;
387}
388
389
390std::shared_ptr<RC_ITEM> SHEETLIST_ERC_ITEMS_PROVIDER::GetItem( int aIndex ) const
391{
392 return GetERCItem( aIndex );
393}
394
395
396void SHEETLIST_ERC_ITEMS_PROVIDER::DeleteItem( int aIndex, bool aDeep )
397{
398 SCH_MARKER* marker = m_filteredMarkers[ aIndex ];
399 m_filteredMarkers.erase( m_filteredMarkers.begin() + aIndex );
400
401 if( aDeep )
402 {
403 SCH_SCREENS screens( m_schematic->Root() );
404 screens.DeleteMarker( marker );
405 }
406}
407
408
const char * name
Definition: DXF_plotter.cpp:57
static std::vector< std::reference_wrapper< RC_ITEM > > GetItemsWithSeverities()
Definition: erc_item.h:76
Container for ERC settings.
Definition: erc_settings.h:122
std::map< wxString, wxString > m_ErcExclusionComments
Definition: erc_settings.h:183
static PIN_ERROR m_defaultPinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Default Look up table which gives the ERC error level for a pair of connected pins.
Definition: erc_settings.h:191
SEVERITY GetSeverity(int aErrorCode) const
ERC_SETTINGS(JSON_SETTINGS *aParent, const std::string &aPath)
void ResetPinMap()
void SetSeverity(int aErrorCode, SEVERITY aSeverity)
virtual ~ERC_SETTINGS()
PIN_ERROR GetPinMapValue(int aFirstType, int aSecondType) const
Definition: erc_settings.h:149
std::map< int, SEVERITY > m_ERCSeverities
Definition: erc_settings.h:181
std::set< wxString > m_ErcExclusions
Definition: erc_settings.h:182
static int m_PinMinDrive[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Look up table which gives the minimal drive for a pair of connected pins on a net.
Definition: erc_settings.h:187
void SetPinMapValue(int aFirstType, int aSecondType, PIN_ERROR aValue)
Definition: erc_settings.h:161
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:185
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
void ReleaseNestedSettings(NESTED_SETTINGS *aSettings)
Saves and frees a nested settings object, if it exists within this one.
bool IsExcluded() const
Definition: marker_base.h:98
std::shared_ptr< RC_ITEM > GetRCItem() const
Definition: marker_base.h:112
enum MARKER_T GetMarkerType() const
Definition: marker_base.h:96
NESTED_SETTINGS is a JSON_SETTINGS that lives inside a JSON_SETTINGS.
JSON_SETTINGS * m_parent
A pointer to the parent object to load and store from.
Like a normal param, but with custom getter and setter functions.
Definition: parameters.h:293
A holder for a rule check item, DRC in Pcbnew or ERC in Eeschema.
Definition: rc_item.h:79
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:100
SCH_SHEET & Root() const
Definition: schematic.h:105
ERC_SETTINGS & ErcSettings() const
Definition: schematic.cpp:296
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:174
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:703
void DeleteMarker(SCH_MARKER *aMarker)
Delete a specific marker.
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
int GetCount(int aSeverity=-1) const override
void SetSeverities(int aSeverities) override
void visitMarkers(std::function< void(SCH_MARKER *)> aVisitor) const
void DeleteItem(int aIndex, bool aDeep) override
Remove (and optionally deletes) the indexed item from the list.
std::shared_ptr< ERC_ITEM > GetERCItem(int aIndex) const
std::vector< SCH_MARKER * > m_filteredMarkers
Definition: erc_settings.h:204
std::shared_ptr< RC_ITEM > GetItem(int aIndex) const override
Retrieve a RC_ITEM by index.
const int ercSettingsSchemaVersion
#define ERR
#define WAR
#define OK
#define DRV
Definition: erc_settings.h:110
@ ERCE_UNSPECIFIED
Definition: erc_settings.h:38
@ ERCE_DRIVER_CONFLICT
Conflicting drivers (labels, etc) on a subgraph.
Definition: erc_settings.h:63
@ ERCE_SIMILAR_LABELS
2 labels are equal for case insensitive comparisons.
Definition: erc_settings.h:51
@ ERCE_FIRST
Definition: erc_settings.h:39
@ ERCE_ENDPOINT_OFF_GRID
Pin or wire-end off grid.
Definition: erc_settings.h:41
@ ERCE_LAST
Definition: erc_settings.h:88
@ ERCE_BUS_ENTRY_CONFLICT
A wire connected to a bus doesn't match the bus.
Definition: erc_settings.h:64
@ ERCE_GLOBLABEL
A global label is unique.
Definition: erc_settings.h:71
@ ERCE_FOOTPRINT_LINK_ISSUES
The footprint link is invalid, or points to a missing (or inactive) footprint or library.
Definition: erc_settings.h:78
@ ERCE_DUPLICATE_PIN_ERROR
Definition: erc_settings.h:92
@ ERCE_NOCONNECT_NOT_CONNECTED
A no connect symbol is not connected to anything.
Definition: erc_settings.h:49
@ ERCE_FOUR_WAY_JUNCTION
A four-way junction was found.
Definition: erc_settings.h:85
@ ERCE_SIMULATION_MODEL
An error was found in the simulation model.
Definition: erc_settings.h:74
@ ERCE_LIB_SYMBOL_MISMATCH
Symbol doesn't match copy in library.
Definition: erc_settings.h:77
@ 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:93
@ ERCE_MISSING_INPUT_PIN
Symbol has input pins that are not placed.
Definition: erc_settings.h:57
@ ERCE_MISSING_UNIT
Symbol has units that are not placed on the schematic.
Definition: erc_settings.h:59
@ ERCE_MISSING_BIDI_PIN
Symbol has bi-directional pins that are not placed.
Definition: erc_settings.h:58
@ ERCE_LIB_SYMBOL_ISSUES
Symbol not found in active libraries.
Definition: erc_settings.h:76
@ ERCE_SINGLE_GLOBAL_LABEL
A global label only exists once in the schematic.
Definition: erc_settings.h:52
@ ERCE_PIN_TO_PIN_ERROR
Definition: erc_settings.h:94
PIN_ERROR
The values a pin-to-pin entry in the pin matrix can take on.
Definition: erc_settings.h:101
#define NOD
Definition: erc_settings.h:112
#define NPI
Types of drive on a net (used for legacy ERC)
Definition: erc_settings.h:109
#define ELECTRICAL_PINTYPES_TOTAL
Definition: pin_type.h:54
SEVERITY
@ RPT_SEVERITY_WARNING
@ RPT_SEVERITY_ERROR
@ RPT_SEVERITY_UNDEFINED
@ RPT_SEVERITY_EXCLUSION
@ RPT_SEVERITY_IGNORE
@ SCH_MARKER_T
Definition: typeinfo.h:158
wxString SeverityToString(const SEVERITY &aSeverity)
Definition: ui_common.cpp:66