KiCad PCB EDA Suite
connection_graph.h
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) 2018 CERN
5 * Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
6 * @author Jon Evans <[email protected]>
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 along
19 * with this program. If not, see <http://www.gnu.org/licenses/>.
20 */
21
22#ifndef _CONNECTION_GRAPH_H
23#define _CONNECTION_GRAPH_H
24
25#include <mutex>
26#include <vector>
27
28#include <erc_settings.h>
29#include <sch_connection.h>
30#include <sch_item.h>
31
32
33#ifdef DEBUG
34// Uncomment this line to enable connectivity debugging features
35// #define CONNECTIVITY_DEBUG
36#endif
37
38
40class SCHEMATIC;
41class SCH_EDIT_FRAME;
42class SCH_HIERLABEL;
43class SCH_PIN;
44class SCH_SHEET_PIN;
45
46
61{
62public:
63 enum class PRIORITY
64 {
65 INVALID = -1,
66 NONE = 0,
67 PIN,
68 SHEET_PIN,
69 HIER_LABEL,
70 LOCAL_LABEL,
71 POWER_PIN,
72 GLOBAL
73 };
74
76 m_graph( aGraph ),
77 m_dirty( false ),
78 m_absorbed( false ),
79 m_absorbed_by( nullptr ),
80 m_code( -1 ),
81 m_multiple_drivers( false ),
82 m_strong_driver( false ),
83 m_local_driver( false ),
84 m_no_connect( nullptr ),
85 m_bus_entry( nullptr ),
86 m_driver( nullptr ),
87 m_driver_connection( nullptr ),
88 m_hier_parent( nullptr ),
89 m_first_driver( nullptr ),
90 m_second_driver( nullptr )
91 {}
92
94
104 bool ResolveDrivers( bool aCheckMultipleDrivers = false );
105
109 wxString GetNetName() const;
110
112 std::vector<SCH_ITEM*> GetBusLabels() const;
113
115 const wxString& GetNameForDriver( SCH_ITEM* aItem );
116
117 const wxString GetNameForDriver( SCH_ITEM* aItem ) const;
118
119 const wxString GetNetclassForDriver( SCH_ITEM* aItem ) const;
120
122 void Absorb( CONNECTION_SUBGRAPH* aOther );
123
125 void AddItem( SCH_ITEM* aItem );
126
129
144 static PRIORITY GetDriverPriority( SCH_ITEM* aDriver );
145
147 {
148 if( m_driver )
149 return GetDriverPriority( m_driver );
150 else
151 return PRIORITY::NONE;
152 }
153
154private:
155 wxString driverName( SCH_ITEM* aItem ) const;
156
157public:
159
161
164
167
168 long m_code;
169
176
179
182
185
188
189 std::vector<SCH_ITEM*> m_items;
190
191 std::vector<SCH_ITEM*> m_drivers;
192
194
196
199
208 std::unordered_map< std::shared_ptr<SCH_CONNECTION>,
209 std::unordered_set<CONNECTION_SUBGRAPH*> > m_bus_neighbors;
210
216 std::unordered_map< std::shared_ptr<SCH_CONNECTION>,
217 std::unordered_set<CONNECTION_SUBGRAPH*> > m_bus_parents;
218
219 // Cache for lookup of any hierarchical (sheet) pins on this subgraph (for referring down)
220 std::vector<SCH_SHEET_PIN*> m_hier_pins;
221
222 // Cache for lookup of any hierarchical ports on this subgraph (for referring up)
223 std::vector<SCH_HIERLABEL*> m_hier_ports;
224
225 // If not null, this indicates the subgraph on a higher level sheet that is linked to this one
227
229 std::unordered_map<SCH_ITEM*, wxString> m_driver_name_cache;
230
236
239};
240
242{
243 wxString Name;
245
246 bool operator==(const NET_NAME_CODE_CACHE_KEY& other) const
247 {
248 return Name == other.Name && Netcode == other.Netcode;
249 }
250};
251
252namespace std
253{
254 template <>
256 {
257 std::size_t operator()( const NET_NAME_CODE_CACHE_KEY& k ) const
258 {
259 const std::size_t prime = 19937;
260
261 return hash<wxString>()( k.Name ) ^ ( hash<int>()( k.Netcode ) * prime );
262 }
263 };
264}
265
267typedef std::unordered_map<NET_NAME_CODE_CACHE_KEY, std::vector<CONNECTION_SUBGRAPH*>> NET_MAP;
268
273{
274public:
275 CONNECTION_GRAPH( SCHEMATIC* aSchematic = nullptr ) :
276 m_last_net_code( 1 ),
277 m_last_bus_code( 1 ),
279 m_schematic( aSchematic )
280 {}
281
283 {
284 Reset();
285 }
286
287 void Reset();
288
289 void SetSchematic( SCHEMATIC* aSchematic )
290 {
291 m_schematic = aSchematic;
292 }
293
301 void Recalculate( const SCH_SHEET_LIST& aSheetList, bool aUnconditional = false,
302 std::function<void( SCH_ITEM* )>* aChangedItemHandler = nullptr );
303
310 std::shared_ptr<BUS_ALIAS> GetBusAlias( const wxString& aName );
311
319 std::vector<const CONNECTION_SUBGRAPH*> GetBusesNeedingMigration();
320
328 int RunERC();
329
331
338 CONNECTION_SUBGRAPH* FindSubgraphByName( const wxString& aNetName,
339 const SCH_SHEET_PATH& aPath );
340
347 CONNECTION_SUBGRAPH* FindFirstSubgraphByName( const wxString& aNetName );
348
350
351private:
379 void updateItemConnectivity( const SCH_SHEET_PATH& aSheet,
380 const std::vector<SCH_ITEM*>& aItemList );
381
395 void buildConnectionGraph( std::function<void( SCH_ITEM* )>* aChangedItemHandler );
396
400 void buildItemSubGraphs();
401
406 void resolveAllDrivers();
407
412
418
422 void processSubGraphs();
423
429 int assignNewNetCode( SCH_CONNECTION& aConnection );
430
435 void assignNetCodesToBus( SCH_CONNECTION* aConnection );
436
443 void propagateToNeighbors( CONNECTION_SUBGRAPH* aSubgraph );
444
455 static SCH_CONNECTION* matchBusMember( SCH_CONNECTION* aBusConnection,
456 SCH_CONNECTION* aSearch );
457
466 std::shared_ptr<SCH_CONNECTION> getDefaultConnection( SCH_ITEM* aItem,
467 CONNECTION_SUBGRAPH* aSubgraph );
468
469 void recacheSubgraphName( CONNECTION_SUBGRAPH* aSubgraph, const wxString& aOldName );
470
478 bool ercCheckMultipleDrivers( const CONNECTION_SUBGRAPH* aSubgraph );
479
480 bool ercCheckNetclassConflicts( const std::vector<CONNECTION_SUBGRAPH*>& subgraphs );
481
490 bool ercCheckBusToNetConflicts( const CONNECTION_SUBGRAPH* aSubgraph );
491
502 bool ercCheckBusToBusConflicts( const CONNECTION_SUBGRAPH* aSubgraph );
503
517
527 bool ercCheckNoConnects( const CONNECTION_SUBGRAPH* aSubgraph );
528
537 bool ercCheckFloatingWires( const CONNECTION_SUBGRAPH* aSubgraph );
538
548 bool ercCheckLabels( const CONNECTION_SUBGRAPH* aSubgraph );
549
557 int ercCheckHierSheets();
558
559public:
560 // TODO(JE) Remove this when pressure valve is removed
561 static bool m_allowRealTime;
562
563private:
564 // All the sheets in the schematic (as long as we don't have partial updates)
566
567 // All connectable items in the schematic
568 std::vector<SCH_ITEM*> m_items;
569
570 // The owner of all CONNECTION_SUBGRAPH objects
571 std::vector<CONNECTION_SUBGRAPH*> m_subgraphs;
572
573 // Cache of a subset of m_subgraphs
574 std::vector<CONNECTION_SUBGRAPH*> m_driver_subgraphs;
575
576 // Cache to lookup subgraphs in m_driver_subgraphs by sheet path
577 std::unordered_map<SCH_SHEET_PATH, std::vector<CONNECTION_SUBGRAPH*>> m_sheet_to_subgraphs_map;
578
579 std::vector<std::pair<SCH_SHEET_PATH, SCH_PIN*>> m_invisible_power_pins;
580
581 std::unordered_map<wxString, std::shared_ptr<BUS_ALIAS>> m_bus_alias_cache;
582
583 std::unordered_map<wxString, int> m_net_name_to_code_map;
584
585 std::unordered_map<wxString, int> m_bus_name_to_code_map;
586
587 std::unordered_map<wxString, std::vector<const CONNECTION_SUBGRAPH*>> m_global_label_cache;
588
589 std::map< std::pair<SCH_SHEET_PATH, wxString>,
590 std::vector<const CONNECTION_SUBGRAPH*> > m_local_label_cache;
591
592 std::unordered_map<wxString, std::vector<CONNECTION_SUBGRAPH*>> m_net_name_to_subgraphs_map;
593
594 std::unordered_map<SCH_ITEM*, CONNECTION_SUBGRAPH*> m_item_to_subgraph_map;
595
597
599
601
603
605};
606
607#endif
Calculates the connectivity of a schematic and generates netlists.
int RunERC()
Runs electrical rule checks on the connectivity graph.
void SetSchematic(SCHEMATIC *aSchematic)
static bool m_allowRealTime
bool ercCheckBusToBusConflicts(const CONNECTION_SUBGRAPH *aSubgraph)
Checks one subgraph for conflicting connections between two bus items.
void processSubGraphs()
Process all subgraphs to assign netcodes and merge subgraphs based on labels.
bool ercCheckNetclassConflicts(const std::vector< CONNECTION_SUBGRAPH * > &subgraphs)
bool ercCheckLabels(const CONNECTION_SUBGRAPH *aSubgraph)
Checks one subgraph for proper connection of labels.
void collectAllDriverValues()
Maps the driver values for each subgraph.
CONNECTION_SUBGRAPH * FindSubgraphByName(const wxString &aNetName, const SCH_SHEET_PATH &aPath)
Returns the subgraph for a given net name on a given sheet.
void recacheSubgraphName(CONNECTION_SUBGRAPH *aSubgraph, const wxString &aOldName)
const NET_MAP & GetNetMap() const
static SCH_CONNECTION * matchBusMember(SCH_CONNECTION *aBusConnection, SCH_CONNECTION *aSearch)
Search for a matching bus member inside a bus connection.
std::unordered_map< wxString, std::shared_ptr< BUS_ALIAS > > m_bus_alias_cache
SCHEMATIC * m_schematic
The schematic this graph represents.
std::unordered_map< SCH_SHEET_PATH, std::vector< CONNECTION_SUBGRAPH * > > m_sheet_to_subgraphs_map
CONNECTION_SUBGRAPH * FindFirstSubgraphByName(const wxString &aNetName)
Retrieves a subgraph for the given net name, if one exists.
void buildItemSubGraphs()
Generates individual item subgraphs on a per-sheet basis.
bool ercCheckMultipleDrivers(const CONNECTION_SUBGRAPH *aSubgraph)
If the subgraph has multiple drivers of equal priority that are graphically connected,...
CONNECTION_SUBGRAPH * GetSubgraphForItem(SCH_ITEM *aItem)
SCH_SHEET_LIST m_sheetList
std::unordered_map< wxString, int > m_net_name_to_code_map
void buildConnectionGraph(std::function< void(SCH_ITEM *)> *aChangedItemHandler)
Generates the connection graph (after all item connectivity has been updated)
void propagateToNeighbors(CONNECTION_SUBGRAPH *aSubgraph)
Updates all neighbors of a subgraph with this one's connectivity info.
int ercCheckHierSheets()
Checks that a hierarchical sheet has at least one matching label inside the sheet for each port on th...
bool ercCheckBusToNetConflicts(const CONNECTION_SUBGRAPH *aSubgraph)
Checks one subgraph for conflicting connections between net and bus labels.
std::shared_ptr< SCH_CONNECTION > getDefaultConnection(SCH_ITEM *aItem, CONNECTION_SUBGRAPH *aSubgraph)
Builds a new default connection for the given item based on its properties.
std::vector< const CONNECTION_SUBGRAPH * > GetBusesNeedingMigration()
Determines which subgraphs have more than one conflicting bus label.
int assignNewNetCode(SCH_CONNECTION &aConnection)
Helper to assign a new net code to a connection.
std::map< std::pair< SCH_SHEET_PATH, wxString >, std::vector< const CONNECTION_SUBGRAPH * > > m_local_label_cache
std::vector< std::pair< SCH_SHEET_PATH, SCH_PIN * > > m_invisible_power_pins
void generateInvisiblePinSubGraphs()
Iterate through the invisible power pins to collect the global labels as drivers.
void assignNetCodesToBus(SCH_CONNECTION *aConnection)
Ensures all members of the bus connection have a valid net code assigned.
std::unordered_map< wxString, int > m_bus_name_to_code_map
std::unordered_map< wxString, std::vector< const CONNECTION_SUBGRAPH * > > m_global_label_cache
std::vector< CONNECTION_SUBGRAPH * > m_subgraphs
CONNECTION_GRAPH(SCHEMATIC *aSchematic=nullptr)
bool ercCheckNoConnects(const CONNECTION_SUBGRAPH *aSubgraph)
Checks one subgraph for proper presence or absence of no-connect symbols.
std::vector< SCH_ITEM * > m_items
std::unordered_map< wxString, std::vector< CONNECTION_SUBGRAPH * > > m_net_name_to_subgraphs_map
std::shared_ptr< BUS_ALIAS > GetBusAlias(const wxString &aName)
Returns a bus alias pointer for the given name if it exists (from cache)
std::unordered_map< SCH_ITEM *, CONNECTION_SUBGRAPH * > m_item_to_subgraph_map
bool ercCheckBusToBusEntryConflicts(const CONNECTION_SUBGRAPH *aSubgraph)
Checks one subgraph for conflicting bus entry to bus connections.
std::vector< CONNECTION_SUBGRAPH * > m_driver_subgraphs
NET_MAP m_net_code_to_subgraphs_map
bool ercCheckFloatingWires(const CONNECTION_SUBGRAPH *aSubgraph)
Checks one subgraph for floating wires.
void resolveAllDrivers()
Finds all subgraphs in the connection graph and calls ResolveDrivers() in parallel.
void updateItemConnectivity(const SCH_SHEET_PATH &aSheet, const std::vector< SCH_ITEM * > &aItemList)
Updates the graphical connectivity between items (i.e.
void Recalculate(const SCH_SHEET_LIST &aSheetList, bool aUnconditional=false, std::function< void(SCH_ITEM *)> *aChangedItemHandler=nullptr)
Updates the connection graph for the given list of sheets.
A subgraph is a set of items that are electrically connected on a single sheet.
wxString driverName(SCH_ITEM *aItem) const
PRIORITY GetDriverPriority()
bool m_strong_driver
True if the driver is "strong": a label or power object.
std::vector< SCH_ITEM * > m_items
SCH_ITEM * m_no_connect
No-connect item in graph, if any.
const wxString & GetNameForDriver(SCH_ITEM *aItem)
Returns the candidate net name for a driver.
std::vector< SCH_ITEM * > m_drivers
SCH_ITEM * m_bus_entry
Bus entry in graph, if any.
SCH_SHEET_PATH m_sheet
void UpdateItemConnections()
Updates all items to match the driver connection.
const wxString GetNetclassForDriver(SCH_ITEM *aItem) const
std::unordered_map< std::shared_ptr< SCH_CONNECTION >, std::unordered_set< CONNECTION_SUBGRAPH * > > m_bus_neighbors
If a subgraph is a bus, this map contains links between the bus members and any local sheet neighbors...
CONNECTION_GRAPH * m_graph
std::unordered_map< SCH_ITEM *, wxString > m_driver_name_cache
A cache of escaped netnames from schematic items.
wxString GetNetName() const
Returns the fully-qualified net name for this subgraph (if one exists)
bool m_multiple_drivers
True if this subgraph contains more than one driver that should be shorted together in the netlist.
bool ResolveDrivers(bool aCheckMultipleDrivers=false)
Determines which potential driver should drive the subgraph.
SCH_ITEM * m_first_driver
Stores the primary driver for the multiple drivers ERC check.
bool m_absorbed
True if this subgraph has been absorbed into another. No pointers here are safe if so!
SCH_CONNECTION * m_driver_connection
Cache for driver connection.
CONNECTION_SUBGRAPH * m_absorbed_by
If this subgraph is absorbed, points to the absorbing (and valid) subgraph.
void AddItem(SCH_ITEM *aItem)
Adds a new item to the subgraph.
std::vector< SCH_ITEM * > GetBusLabels() const
Returns all the bus labels attached to this subgraph (if any)
void Absorb(CONNECTION_SUBGRAPH *aOther)
Combines another subgraph on the same sheet into this one.
std::unordered_map< std::shared_ptr< SCH_CONNECTION >, std::unordered_set< CONNECTION_SUBGRAPH * > > m_bus_parents
If this is a net, this vector contains links to any same-sheet buses that contain it.
CONNECTION_SUBGRAPH(CONNECTION_GRAPH *aGraph)
std::vector< SCH_HIERLABEL * > m_hier_ports
std::vector< SCH_SHEET_PIN * > m_hier_pins
~CONNECTION_SUBGRAPH()=default
CONNECTION_SUBGRAPH * m_hier_parent
SCH_ITEM * m_second_driver
Used for multiple drivers ERC message; stores the second possible driver (or nullptr)
bool m_local_driver
True if the driver is a local (i.e. non-global) type.
Holds all the data relating to one schematic.
Definition: schematic.h:60
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
Schematic editor (Eeschema) main window.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:147
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:66
std::unordered_map< NET_NAME_CODE_CACHE_KEY, std::vector< CONNECTION_SUBGRAPH * > > NET_MAP
Associates a NET_CODE_NAME with all the subgraphs in that net.
@ INVALID
Definition: kiface_ids.h:32
Definition: bitmap.cpp:64
bool operator==(const NET_NAME_CODE_CACHE_KEY &other) const
std::size_t operator()(const NET_NAME_CODE_CACHE_KEY &k) const