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.
117
118 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "rule_severities",
119 [&]() -> nlohmann::json
120 {
121 nlohmann::json ret = {};
122
123 for( const RC_ITEM& item : ERC_ITEM::GetItemsWithSeverities() )
124 {
125 wxString name = item.GetSettingsKey();
126 int code = item.GetErrorCode();
127
128 if( name.IsEmpty() || m_ERCSeverities.count( code ) == 0 )
129 continue;
130
131 ret[std::string( name.ToUTF8() )] = SeverityToString( m_ERCSeverities[code] );
132 }
133
134 return ret;
135 },
136 [&]( const nlohmann::json& aJson )
137 {
138 if( !aJson.is_object() )
139 return;
140
141 for( const RC_ITEM& item : ERC_ITEM::GetItemsWithSeverities() )
142 {
143 int code = item.GetErrorCode();
144 wxString name = item.GetSettingsKey();
145
146 std::string key( name.ToUTF8() );
147
148 if( aJson.contains( key ) )
149 m_ERCSeverities[code] = SeverityFromString( aJson[key] );
150 }
151 },
152 {} ) );
153
154 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "erc_exclusions",
155 [&]() -> nlohmann::json
156 {
157 nlohmann::json js = nlohmann::json::array();
158
159 for( const wxString& entry : m_ErcExclusions )
160 js.push_back( { entry, m_ErcExclusionComments[ entry ] } );
161
162 return js;
163 },
164 [&]( const nlohmann::json& aObj )
165 {
166 m_ErcExclusions.clear();
167
168 if( !aObj.is_array() )
169 return;
170
171 for( const nlohmann::json& entry : aObj )
172 {
173 if( entry.is_array() )
174 {
175 wxString serialized = entry[0].get<wxString>();
176 m_ErcExclusions.insert( serialized );
177 m_ErcExclusionComments[ serialized ] = entry[1].get<wxString>();
178 }
179 else if( entry.is_string() )
180 {
181 m_ErcExclusions.insert( entry.get<wxString>() );
182 }
183 }
184 },
185 {} ) );
186
187 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "pin_map",
188 [&]() -> nlohmann::json
189 {
190 nlohmann::json ret = nlohmann::json::array();
191
192 for( int i = 0; i < ELECTRICAL_PINTYPES_TOTAL; i++ )
193 {
194 nlohmann::json inner = nlohmann::json::array();
195
196 for( int j = 0; j < ELECTRICAL_PINTYPES_TOTAL; j++ )
197 inner.push_back( static_cast<int>( GetPinMapValue( i, j ) ) );
198
199 ret.push_back( inner );
200 }
201
202 return ret;
203 },
204 [&]( const nlohmann::json& aJson )
205 {
206 if( !aJson.is_array() || aJson.size() != ELECTRICAL_PINTYPES_TOTAL )
207 return;
208
209 for( size_t i = 0; i < ELECTRICAL_PINTYPES_TOTAL; i++ )
210 {
211 if( i > aJson.size() - 1 )
212 break;
213
214 nlohmann::json inner = aJson[i];
215
216 if( !inner.is_array() || inner.size() != ELECTRICAL_PINTYPES_TOTAL )
217 return;
218
219 for( size_t j = 0; j < ELECTRICAL_PINTYPES_TOTAL; j++ )
220 {
221 if( inner[j].is_number_integer() )
222 {
223 int val = inner[j].get<int>();
224
225 if( val >= 0 && val <= static_cast<int>( PIN_ERROR::UNCONNECTED ) )
226 SetPinMapValue( i, j, static_cast<PIN_ERROR>( val ) );
227 }
228 }
229 }
230 },
231 {} ) );
232}
233
234
236{
237 if( m_parent )
238 {
240 m_parent = nullptr;
241 }
242}
243
244
245SEVERITY ERC_SETTINGS::GetSeverity( int aErrorCode ) const
246{
247 // Special-case duplicate pin error. Unique pin names are required by KiCad, so this
248 // is always an error.
249 if( aErrorCode == ERCE_DUPLICATE_PIN_ERROR )
250 {
251 return RPT_SEVERITY_ERROR;
252 }
253 // Special-case pin-to-pin errors:
254 // Ignore-or-not is controlled by ERCE_PIN_TO_PIN_WARNING (for both)
255 // Warning-or-error is controlled by which errorCode it is
256 else if( aErrorCode == ERCE_PIN_TO_PIN_ERROR )
257 {
258 wxASSERT( m_ERCSeverities.count( ERCE_PIN_TO_PIN_WARNING ) );
259
261 return RPT_SEVERITY_IGNORE;
262 else
263 return RPT_SEVERITY_ERROR;
264 }
265 else if( aErrorCode == ERCE_PIN_TO_PIN_WARNING )
266 {
267 wxASSERT( m_ERCSeverities.count( ERCE_PIN_TO_PIN_WARNING ) );
268
270 return RPT_SEVERITY_IGNORE;
271 else
273 }
274 else if( aErrorCode == ERCE_GENERIC_WARNING )
275 {
277 }
278 else if( aErrorCode == ERCE_GENERIC_ERROR )
279 {
280 return RPT_SEVERITY_ERROR;
281 }
282
283 wxCHECK_MSG( m_ERCSeverities.count( aErrorCode ), RPT_SEVERITY_IGNORE,
284 wxS( "Missing severity from map in ERC_SETTINGS!" ) );
285
286 return m_ERCSeverities.at( aErrorCode );
287}
288
289
290void ERC_SETTINGS::SetSeverity( int aErrorCode, SEVERITY aSeverity )
291{
292 m_ERCSeverities[ aErrorCode ] = aSeverity;
293}
294
295
297{
298 memcpy( m_PinMap, m_defaultPinMap, sizeof( m_PinMap ) );
299}
300
301
302void SHEETLIST_ERC_ITEMS_PROVIDER::visitMarkers( std::function<void( SCH_MARKER* )> aVisitor ) const
303{
304 std::set<SCH_SCREEN*> seenScreens;
305
306 for( const SCH_SHEET_PATH& sheet : m_schematic->BuildUnorderedSheetList() )
307 {
308 bool firstTime = seenScreens.count( sheet.LastScreen() ) == 0;
309
310 if( firstTime )
311 seenScreens.insert( sheet.LastScreen() );
312
313 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_MARKER_T ) )
314 {
315 SCH_MARKER* marker = static_cast<SCH_MARKER*>( item );
316
317 if( marker->GetMarkerType() != MARKER_BASE::MARKER_ERC )
318 continue;
319
320 std::shared_ptr<const ERC_ITEM> ercItem =
321 std::static_pointer_cast<const ERC_ITEM>( marker->GetRCItem() );
322
323 // Only show sheet-specific markers on the owning sheet
324 if( ercItem->IsSheetSpecific() )
325 {
326 if( ercItem->GetSpecificSheetPath() != sheet )
327 continue;
328 }
329
330 // Don't show non-specific markers more than once
331 if( !firstTime && !ercItem->IsSheetSpecific() )
332 continue;
333
334 aVisitor( marker );
335 }
336 }
337}
338
339
341{
342 m_severities = aSeverities;
343
344 m_filteredMarkers.clear();
345
346 ERC_SETTINGS& settings = m_schematic->ErcSettings();
347
349 [&]( SCH_MARKER* aMarker )
350 {
351 SEVERITY markerSeverity;
352
353 if( aMarker->IsExcluded() )
354 markerSeverity = RPT_SEVERITY_EXCLUSION;
355 else
356 markerSeverity = settings.GetSeverity( aMarker->GetRCItem()->GetErrorCode() );
357
358 if( markerSeverity & m_severities )
359 m_filteredMarkers.push_back( aMarker );
360 } );
361}
362
363
365{
366 if( aSeverity < 0 )
367 return m_filteredMarkers.size();
368
369 int count = 0;
370
371 const ERC_SETTINGS& settings = m_schematic->ErcSettings();
372
374 [&]( SCH_MARKER* aMarker )
375 {
376 SEVERITY markerSeverity;
377
378 if( aMarker->IsExcluded() )
379 markerSeverity = RPT_SEVERITY_EXCLUSION;
380 else
381 markerSeverity = settings.GetSeverity( aMarker->GetRCItem()->GetErrorCode() );
382
383 if( ( markerSeverity & aSeverity ) > 0 )
384 count++;
385 } );
386
387 return count;
388}
389
390
391std::shared_ptr<ERC_ITEM> SHEETLIST_ERC_ITEMS_PROVIDER::GetERCItem( int aIndex ) const
392{
393 SCH_MARKER* marker = m_filteredMarkers[ aIndex ];
394
395 return marker ? std::static_pointer_cast<ERC_ITEM>( marker->GetRCItem() ) : nullptr;
396}
397
398
399std::shared_ptr<RC_ITEM> SHEETLIST_ERC_ITEMS_PROVIDER::GetItem( int aIndex ) const
400{
401 return GetERCItem( aIndex );
402}
403
404
405void SHEETLIST_ERC_ITEMS_PROVIDER::DeleteItem( int aIndex, bool aDeep )
406{
407 SCH_MARKER* marker = m_filteredMarkers[ aIndex ];
408 m_filteredMarkers.erase( m_filteredMarkers.begin() + aIndex );
409
410 if( aDeep )
411 {
412 SCH_SCREENS screens( m_schematic->Root() );
413 screens.DeleteMarker( marker );
414 }
415}
416
417
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:127
std::map< wxString, wxString > m_ErcExclusionComments
Definition: erc_settings.h:188
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:196
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:154
std::map< int, SEVERITY > m_ERCSeverities
Definition: erc_settings.h:186
std::set< wxString > m_ErcExclusions
Definition: erc_settings.h:187
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:192
void SetPinMapValue(int aFirstType, int aSecondType, PIN_ERROR aValue)
Definition: erc_settings.h:166
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:190
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 BuildUnorderedSheetList() const
Definition: schematic.h:101
SCH_SHEET & Root() const
Definition: schematic.h:113
ERC_SETTINGS & ErcSettings() const
Definition: schematic.cpp:304
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:166
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:710
void DeleteMarker(SCH_MARKER *aMarker)
Delete a specific marker.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
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:209
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:115
@ ERCE_UNSPECIFIED
Definition: erc_settings.h:38
@ ERCE_DRIVER_CONFLICT
Conflicting drivers (labels, etc) on a subgraph.
Definition: erc_settings.h:65
@ ERCE_SIMILAR_POWER
2 power pins are equal for case insensitive comparisons.
Definition: erc_settings.h:52
@ 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:91
@ ERCE_SIMILAR_LABEL_AND_POWER
label and pin are equal for case insensitive comparisons.
Definition: erc_settings.h:53
@ ERCE_BUS_ENTRY_CONFLICT
A wire connected to a bus doesn't match the bus.
Definition: erc_settings.h:66
@ ERCE_GLOBLABEL
A global label is unique.
Definition: erc_settings.h:73
@ ERCE_FOOTPRINT_LINK_ISSUES
The footprint link is invalid, or points to a missing (or inactive) footprint or library.
Definition: erc_settings.h:80
@ ERCE_DUPLICATE_PIN_ERROR
Definition: erc_settings.h:95
@ 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:87
@ ERCE_SIMULATION_MODEL
An error was found in the simulation model.
Definition: erc_settings.h:76
@ ERCE_LIB_SYMBOL_MISMATCH
Symbol doesn't match copy in library.
Definition: erc_settings.h:79
@ ERCE_GENERIC_ERROR
Definition: erc_settings.h:101
@ 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:96
@ ERCE_MISSING_INPUT_PIN
Symbol has input pins that are not placed.
Definition: erc_settings.h:59
@ ERCE_MISSING_UNIT
Symbol has units that are not placed on the schematic.
Definition: erc_settings.h:61
@ ERCE_MISSING_BIDI_PIN
Symbol has bi-directional pins that are not placed.
Definition: erc_settings.h:60
@ ERCE_LIB_SYMBOL_ISSUES
Symbol not found in active libraries.
Definition: erc_settings.h:78
@ ERCE_GENERIC_WARNING
Definition: erc_settings.h:100
@ ERCE_SINGLE_GLOBAL_LABEL
A global label only exists once in the schematic.
Definition: erc_settings.h:54
@ 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:97
PIN_ERROR
The values a pin-to-pin entry in the pin matrix can take on.
Definition: erc_settings.h:106
#define NOD
Definition: erc_settings.h:117
#define NPI
Types of drive on a net (used for legacy ERC)
Definition: erc_settings.h:114
#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