KiCad PCB EDA Suite
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_item.h>
22#include <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.
106
107 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "rule_severities",
108 [&]() -> nlohmann::json
109 {
110 nlohmann::json ret = {};
111
112 for( const RC_ITEM& item : ERC_ITEM::GetItemsWithSeverities() )
113 {
114 wxString name = item.GetSettingsKey();
115 int code = item.GetErrorCode();
116
117 if( name.IsEmpty() || m_ERCSeverities.count( code ) == 0 )
118 continue;
119
120 ret[std::string( name.ToUTF8() )] = SeverityToString( m_ERCSeverities[code] );
121 }
122
123 return ret;
124 },
125 [&]( const nlohmann::json& aJson )
126 {
127 if( !aJson.is_object() )
128 return;
129
130 for( const RC_ITEM& item : ERC_ITEM::GetItemsWithSeverities() )
131 {
132 int code = item.GetErrorCode();
133 wxString name = item.GetSettingsKey();
134
135 std::string key( name.ToUTF8() );
136
137 if( aJson.contains( key ) )
138 m_ERCSeverities[code] = SeverityFromString( aJson[key] );
139 }
140 },
141 {} ) );
142
143 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "erc_exclusions",
144 [&]() -> nlohmann::json
145 {
146 nlohmann::json js = nlohmann::json::array();
147
148 for( const auto& entry : m_ErcExclusions )
149 js.push_back( entry );
150
151 return js;
152 },
153 [&]( const nlohmann::json& aObj )
154 {
155 m_ErcExclusions.clear();
156
157 if( !aObj.is_array() )
158 return;
159
160 for( const nlohmann::json& entry : aObj )
161 {
162 if( entry.empty() )
163 continue;
164
165 m_ErcExclusions.insert( entry.get<wxString>() );
166 }
167 },
168 {} ) );
169
170 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "pin_map",
171 [&]() -> nlohmann::json
172 {
173 nlohmann::json ret = nlohmann::json::array();
174
175 for( int i = 0; i < ELECTRICAL_PINTYPES_TOTAL; i++ )
176 {
177 nlohmann::json inner = nlohmann::json::array();
178
179 for( int j = 0; j < ELECTRICAL_PINTYPES_TOTAL; j++ )
180 inner.push_back( static_cast<int>( GetPinMapValue( i, j ) ) );
181
182 ret.push_back( inner );
183 }
184
185 return ret;
186 },
187 [&]( const nlohmann::json& aJson )
188 {
189 if( !aJson.is_array() || aJson.size() != ELECTRICAL_PINTYPES_TOTAL )
190 return;
191
192 for( size_t i = 0; i < ELECTRICAL_PINTYPES_TOTAL; i++ )
193 {
194 if( i > aJson.size() - 1 )
195 break;
196
197 nlohmann::json inner = aJson[i];
198
199 if( !inner.is_array() || inner.size() != ELECTRICAL_PINTYPES_TOTAL )
200 return;
201
202 for( size_t j = 0; j < ELECTRICAL_PINTYPES_TOTAL; j++ )
203 {
204 if( inner[j].is_number_integer() )
205 {
206 int val = inner[j].get<int>();
207
208 if( val >= 0 && val <= static_cast<int>( PIN_ERROR::UNCONNECTED ) )
209 SetPinMapValue( i, j, static_cast<PIN_ERROR>( val ) );
210 }
211 }
212 }
213 },
214 {} ) );
215}
216
217
219{
220 if( m_parent )
221 {
223 m_parent = nullptr;
224 }
225}
226
227
228SEVERITY ERC_SETTINGS::GetSeverity( int aErrorCode ) const
229{
230 // Special-case pin-to-pin errors:
231 // Ignore-or-not is controlled by ERCE_PIN_TO_PIN_WARNING (for both)
232 // Warning-or-error is controlled by which errorCode it is
233 if( aErrorCode == ERCE_PIN_TO_PIN_ERROR )
234 {
235 wxASSERT( m_ERCSeverities.count( ERCE_PIN_TO_PIN_WARNING ) );
236
238 return RPT_SEVERITY_IGNORE;
239 else
240 return RPT_SEVERITY_ERROR;
241 }
242 else if( aErrorCode == ERCE_PIN_TO_PIN_WARNING )
243 {
244 wxASSERT( m_ERCSeverities.count( ERCE_PIN_TO_PIN_WARNING ) );
245
247 return RPT_SEVERITY_IGNORE;
248 else
250 }
251
252 wxCHECK_MSG( m_ERCSeverities.count( aErrorCode ), RPT_SEVERITY_IGNORE,
253 "Missing severity from map in ERC_SETTINGS!" );
254
255 return m_ERCSeverities.at( aErrorCode );
256}
257
258
259void ERC_SETTINGS::SetSeverity( int aErrorCode, SEVERITY aSeverity )
260{
261 m_ERCSeverities[ aErrorCode ] = aSeverity;
262}
263
264
266{
267 memcpy( m_PinMap, m_defaultPinMap, sizeof( m_PinMap ) );
268}
269
270
271void SHEETLIST_ERC_ITEMS_PROVIDER::visitMarkers( std::function<void( SCH_MARKER* )> aVisitor ) const
272{
273 SCH_SHEET_LIST sheetList = m_schematic->GetSheets();
274
275 std::set<SCH_SCREEN*> seenScreens;
276
277 for( unsigned i = 0; i < sheetList.size(); i++ )
278 {
279 bool firstTime = seenScreens.count( sheetList[i].LastScreen() ) == 0;
280
281 if( firstTime )
282 seenScreens.insert( sheetList[i].LastScreen() );
283
284 for( SCH_ITEM* item : sheetList[i].LastScreen()->Items().OfType( SCH_MARKER_T ) )
285 {
286 SCH_MARKER* marker = static_cast<SCH_MARKER*>( item );
287
288 if( marker->GetMarkerType() != MARKER_BASE::MARKER_ERC )
289 continue;
290
291 // Don't show non-specific markers more than once
292 if( !firstTime &&
293 !static_cast<const ERC_ITEM*>( marker->GetRCItem().get() )->IsSheetSpecific() )
294 {
295 continue;
296 }
297
298 aVisitor( marker );
299 }
300 }
301}
302
303
305{
306 m_severities = aSeverities;
307
308 m_filteredMarkers.clear();
309
310 ERC_SETTINGS& settings = m_schematic->ErcSettings();
311
313 [&]( SCH_MARKER* aMarker )
314 {
315 SEVERITY markerSeverity;
316
317 if( aMarker->IsExcluded() )
318 markerSeverity = RPT_SEVERITY_EXCLUSION;
319 else
320 markerSeverity = settings.GetSeverity( aMarker->GetRCItem()->GetErrorCode() );
321
322 if( markerSeverity & m_severities )
323 m_filteredMarkers.push_back( aMarker );
324 } );
325}
326
327
329{
330 if( aSeverity < 0 )
331 return m_filteredMarkers.size();
332
333 int count = 0;
334
335 const ERC_SETTINGS& settings = m_schematic->ErcSettings();
336
338 [&]( SCH_MARKER* aMarker )
339 {
340 SEVERITY markerSeverity;
341
342 if( aMarker->IsExcluded() )
343 markerSeverity = RPT_SEVERITY_EXCLUSION;
344 else
345 markerSeverity = settings.GetSeverity( aMarker->GetRCItem()->GetErrorCode() );
346
347 if( ( markerSeverity & aSeverity ) > 0 )
348 count++;
349 } );
350
351 return count;
352}
353
354
355std::shared_ptr<ERC_ITEM> SHEETLIST_ERC_ITEMS_PROVIDER::GetERCItem( int aIndex ) const
356{
357 SCH_MARKER* marker = m_filteredMarkers[ aIndex ];
358
359 return marker ? std::static_pointer_cast<ERC_ITEM>( marker->GetRCItem() ) : nullptr;
360}
361
362
363std::shared_ptr<RC_ITEM> SHEETLIST_ERC_ITEMS_PROVIDER::GetItem( int aIndex ) const
364{
365 return GetERCItem( aIndex );
366}
367
368
369void SHEETLIST_ERC_ITEMS_PROVIDER::DeleteItem( int aIndex, bool aDeep )
370{
371 SCH_MARKER* marker = m_filteredMarkers[ aIndex ];
372 m_filteredMarkers.erase( m_filteredMarkers.begin() + aIndex );
373
374 if( aDeep )
375 {
376 SCH_SCREENS screens( m_schematic->Root() );
377 screens.DeleteMarker( marker );
378 }
379}
380
381
const char * name
Definition: DXF_plotter.cpp:56
static std::vector< std::reference_wrapper< RC_ITEM > > GetItemsWithSeverities()
Definition: erc_item.h:50
bool IsSheetSpecific() const
Definition: erc_item.h:55
Container for ERC settings.
Definition: erc_settings.h:109
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:177
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:136
std::map< int, SEVERITY > m_ERCSeverities
Definition: erc_settings.h:168
std::set< wxString > m_ErcExclusions
Definition: erc_settings.h:169
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:173
void SetPinMapValue(int aFirstType, int aSecondType, PIN_ERROR aValue)
Definition: erc_settings.h:148
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:171
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:97
std::shared_ptr< RC_ITEM > GetRCItem() const
Definition: marker_base.h:105
enum TYPEMARKER GetMarkerType() const
Definition: marker_base.h:95
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.
A holder for a rule check item, DRC in Pcbnew or ERC in Eeschema.
Definition: rc_item.h:75
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:85
SCH_SHEET & Root() const
Definition: schematic.h:90
ERC_SETTINGS & ErcSettings() const
Definition: schematic.cpp:179
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:147
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:613
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:190
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:97
@ ERCE_UNSPECIFIED
Definition: erc_settings.h:38
@ ERCE_DRIVER_CONFLICT
Conflicting drivers (labels, etc) on a subgraph.
Definition: erc_settings.h:57
@ 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:76
@ ERCE_BUS_ENTRY_CONFLICT
A wire connected to a bus doesn't match the bus.
Definition: erc_settings.h:58
@ ERCE_GLOBLABEL
A global label is unique.
Definition: erc_settings.h:65
@ ERCE_NOCONNECT_NOT_CONNECTED
A no connect symbol is not connected to anything.
Definition: erc_settings.h:49
@ 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:80
@ ERCE_LIB_SYMBOL_ISSUES
Library symbol changed from current symbol in schematic or the library symbol link no longer valid.
Definition: erc_settings.h:68
@ ERCE_PIN_TO_PIN_ERROR
Definition: erc_settings.h:81
PIN_ERROR
The values a pin-to-pin entry in the pin matrix can take on.
Definition: erc_settings.h:88
#define NOD
Definition: erc_settings.h:99
#define NPI
Types of drive on a net (used for legacy ERC)
Definition: erc_settings.h:96
nlohmann::json json
Definition: gerbview.cpp:44
#define ELECTRICAL_PINTYPES_TOTAL
Definition: pin_type.h:53
SEVERITY
@ RPT_SEVERITY_WARNING
@ RPT_SEVERITY_ERROR
@ RPT_SEVERITY_UNDEFINED
@ RPT_SEVERITY_EXCLUSION
@ RPT_SEVERITY_IGNORE
@ SCH_MARKER_T
Definition: typeinfo.h:140
wxString SeverityToString(const SEVERITY &aSeverity)
Definition: ui_common.cpp:59