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  * @author Jon Evans <jon@craftyjon.com>
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU 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 #ifndef _CONNECTION_GRAPH_H
22 #define _CONNECTION_GRAPH_H
23 
24 #include <mutex>
25 #include <vector>
26 
27 #include <common.h>
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 
39 class CONNECTION_GRAPH;
40 class SCHEMATIC;
41 class SCH_EDIT_FRAME;
42 class SCH_HIERLABEL;
43 class SCH_PIN;
44 class SCH_SHEET_PIN;
45 
46 
61 {
62 public:
63  enum class PRIORITY
64  {
65  INVALID = -1,
66  NONE = 0,
67  PIN,
68  SHEET_PIN,
69  HIER_LABEL,
71  POWER_PIN,
72  GLOBAL
73  };
74 
75  explicit CONNECTION_SUBGRAPH( CONNECTION_GRAPH* aGraph ) :
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  {}
90 
91  ~CONNECTION_SUBGRAPH() = default;
92 
102  bool ResolveDrivers( bool aCreateMarkers = false );
103 
107  wxString GetNetName() const;
108 
110  std::vector<SCH_ITEM*> GetBusLabels() const;
111 
113  const wxString& GetNameForDriver( SCH_ITEM* aItem );
114 
116  void Absorb( CONNECTION_SUBGRAPH* aOther );
117 
119  void AddItem( SCH_ITEM* aItem );
120 
122  void UpdateItemConnections();
123 
138  static PRIORITY GetDriverPriority( SCH_ITEM* aDriver );
139 
141 
142  bool m_dirty;
143 
146 
149 
150  long m_code;
151 
158 
161 
164 
167 
170 
171  std::vector<SCH_ITEM*> m_items;
172 
173  std::vector<SCH_ITEM*> m_drivers;
174 
176 
178 
181 
190  std::unordered_map< std::shared_ptr<SCH_CONNECTION>,
191  std::unordered_set<CONNECTION_SUBGRAPH*> > m_bus_neighbors;
192 
198  std::unordered_map< std::shared_ptr<SCH_CONNECTION>,
199  std::unordered_set<CONNECTION_SUBGRAPH*> > m_bus_parents;
200 
201  // Cache for lookup of any hierarchical (sheet) pins on this subgraph (for referring down)
202  std::vector<SCH_SHEET_PIN*> m_hier_pins;
203 
204  // Cache for lookup of any hierarchical ports on this subgraph (for referring up)
205  std::vector<SCH_HIERLABEL*> m_hier_ports;
206 
207  // If not null, this indicates the subgraph on a higher level sheet that is linked to this one
209 
211  std::unordered_map<SCH_ITEM*, wxString> m_driver_name_cache;
212 };
213 
215 typedef std::pair<wxString, int> NET_NAME_CODE;
216 
218 typedef std::map<NET_NAME_CODE, std::vector<CONNECTION_SUBGRAPH*>> NET_MAP;
219 
224 {
225 public:
226  CONNECTION_GRAPH( SCHEMATIC* aSchematic = nullptr ) :
227  m_last_net_code( 1 ),
228  m_last_bus_code( 1 ),
230  m_schematic( aSchematic )
231  {}
232 
234  {
235  Reset();
236  }
237 
238  void Reset();
239 
240  void SetSchematic( SCHEMATIC* aSchematic )
241  {
242  m_schematic = aSchematic;
243  }
244 
251  void Recalculate( const SCH_SHEET_LIST& aSheetList, bool aUnconditional = false );
252 
259  std::shared_ptr<BUS_ALIAS> GetBusAlias( const wxString& aName );
260 
268  std::vector<const CONNECTION_SUBGRAPH*> GetBusesNeedingMigration();
269 
277  int RunERC();
278 
279  const NET_MAP& GetNetMap() const { return m_net_code_to_subgraphs_map; }
280 
287  CONNECTION_SUBGRAPH* FindSubgraphByName( const wxString& aNetName,
288  const SCH_SHEET_PATH& aPath );
289 
296  CONNECTION_SUBGRAPH* FindFirstSubgraphByName( const wxString& aNetName );
297 
299 
300  // TODO(JE) Remove this when pressure valve is removed
301  static bool m_allowRealTime;
302 
303 private:
304  // All the sheets in the schematic (as long as we don't have partial updates)
306 
307  // All connectable items in the schematic
308  std::vector<SCH_ITEM*> m_items;
309 
310  // The owner of all CONNECTION_SUBGRAPH objects
311  std::vector<CONNECTION_SUBGRAPH*> m_subgraphs;
312 
313  // Cache of a subset of m_subgraphs
314  std::vector<CONNECTION_SUBGRAPH*> m_driver_subgraphs;
315 
316  // Cache to lookup subgraphs in m_driver_subgraphs by sheet path
317  std::unordered_map<SCH_SHEET_PATH,
318  std::vector<CONNECTION_SUBGRAPH*>> m_sheet_to_subgraphs_map;
319 
320  std::vector<std::pair<SCH_SHEET_PATH, SCH_PIN*>> m_invisible_power_pins;
321 
322  std::unordered_map< wxString, std::shared_ptr<BUS_ALIAS> > m_bus_alias_cache;
323 
324  std::map<wxString, int> m_net_name_to_code_map;
325 
326  std::map<wxString, int> m_bus_name_to_code_map;
327 
328  std::map<wxString, std::vector<const CONNECTION_SUBGRAPH*>> m_global_label_cache;
329 
330  std::map< std::pair<SCH_SHEET_PATH, wxString>,
331  std::vector<const CONNECTION_SUBGRAPH*> > m_local_label_cache;
332 
333  std::unordered_map<wxString,
334  std::vector<CONNECTION_SUBGRAPH*>> m_net_name_to_subgraphs_map;
335 
336  std::map<SCH_ITEM*, CONNECTION_SUBGRAPH*> m_item_to_subgraph_map;
337 
339 
341 
343 
345 
347 
375  void updateItemConnectivity( const SCH_SHEET_PATH& aSheet,
376  const std::vector<SCH_ITEM*>& aItemList );
377 
391  void buildConnectionGraph();
392 
398  int assignNewNetCode( SCH_CONNECTION& aConnection );
399 
404  void assignNetCodesToBus( SCH_CONNECTION* aConnection );
405 
412  void propagateToNeighbors( CONNECTION_SUBGRAPH* aSubgraph );
413 
424  static SCH_CONNECTION* matchBusMember( SCH_CONNECTION* aBusConnection,
425  SCH_CONNECTION* aSearch );
426 
435  std::shared_ptr<SCH_CONNECTION> getDefaultConnection( SCH_ITEM* aItem,
436  CONNECTION_SUBGRAPH* aSubgraph );
437 
438  void recacheSubgraphName( CONNECTION_SUBGRAPH* aSubgraph, const wxString& aOldName );
439 
448  bool ercCheckBusToNetConflicts( const CONNECTION_SUBGRAPH* aSubgraph );
449 
460  bool ercCheckBusToBusConflicts( const CONNECTION_SUBGRAPH* aSubgraph );
461 
474  bool ercCheckBusToBusEntryConflicts( const CONNECTION_SUBGRAPH* aSubgraph );
475 
485  bool ercCheckNoConnects( const CONNECTION_SUBGRAPH* aSubgraph );
486 
495  bool ercCheckFloatingWires( const CONNECTION_SUBGRAPH* aSubgraph );
496 
506  bool ercCheckLabels( const CONNECTION_SUBGRAPH* aSubgraph );
507 
515  int ercCheckHierSheets();
516 
517 };
518 
519 #endif
CONNECTION_SUBGRAPH * FindSubgraphByName(const wxString &aNetName, const SCH_SHEET_PATH &aPath)
Returns the subgraph for a given net name on a given sheet.
SCH_SHEET_PATH m_sheet
SCH_SHEET_LIST.
SCH_CONNECTION * m_driver_connection
Cache for driver connection.
void SetSchematic(SCHEMATIC *aSchematic)
void propagateToNeighbors(CONNECTION_SUBGRAPH *aSubgraph)
Updates all neighbors of a subgraph with this one's connectivity info.
bool ercCheckBusToBusEntryConflicts(const CONNECTION_SUBGRAPH *aSubgraph)
Checks one subgraph for conflicting bus entry to bus connections.
void buildConnectionGraph()
Generates the connection graph (after all item connectivity has been updated)
std::unordered_map< wxString, std::shared_ptr< BUS_ALIAS > > m_bus_alias_cache
Holds all the data relating to one schematic A schematic may consist of one or more sheets (and one r...
Definition: schematic.h:42
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< 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...
SCH_ITEM * m_bus_entry
Bus entry in graph, if any.
CONNECTION_SUBGRAPH(CONNECTION_GRAPH *aGraph)
Calculates the connectivity of a schematic and generates netlists.
void Recalculate(const SCH_SHEET_LIST &aSheetList, bool aUnconditional=false)
Updates the connection graph for the given list of sheets.
void Absorb(CONNECTION_SUBGRAPH *aOther)
Combines another subgraph on the same sheet into this one.
bool m_absorbed
True if this subgraph has been absorbed into another. No pointers here are safe if so!
std::unordered_map< SCH_SHEET_PATH, std::vector< CONNECTION_SUBGRAPH * > > m_sheet_to_subgraphs_map
static PRIORITY GetDriverPriority(SCH_ITEM *aDriver)
Returns the priority (higher is more important) of a candidate driver.
std::pair< wxString, int > NET_NAME_CODE
Associates a net code with the final name of a net.
bool ercCheckFloatingWires(const CONNECTION_SUBGRAPH *aSubgraph)
Checks one subgraph for floating wires.
std::vector< SCH_SHEET_PIN * > m_hier_pins
bool m_local_driver
True if the driver is a local (i.e. non-global) type.
std::vector< CONNECTION_SUBGRAPH * > m_subgraphs
~CONNECTION_SUBGRAPH()=default
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.
NET_MAP m_net_code_to_subgraphs_map
Schematic editor (Eeschema) main window.
std::vector< SCH_ITEM * > m_items
SCHEMATIC * m_schematic
The schematic this graph represents.
std::unordered_map< wxString, std::vector< CONNECTION_SUBGRAPH * > > m_net_name_to_subgraphs_map
A subgraph is a set of items that are electrically connected on a single sheet.
bool ResolveDrivers(bool aCreateMarkers=false)
Determines which potential driver should drive the subgraph.
void updateItemConnectivity(const SCH_SHEET_PATH &aSheet, const std::vector< SCH_ITEM * > &aItemList)
Updates the graphical connectivity between items (i.e.
int ercCheckHierSheets()
Checks that a hierarchical sheet has at least one matching label inside the sheet for each port on th...
bool m_multiple_drivers
True if this subgraph contains more than one driver that should be shorted together in the netlist.
void recacheSubgraphName(CONNECTION_SUBGRAPH *aSubgraph, const wxString &aOldName)
bool ercCheckBusToNetConflicts(const CONNECTION_SUBGRAPH *aSubgraph)
Checks one subgraph for conflicting connections between net and bus labels.
CONNECTION_GRAPH * m_graph
const wxString & GetNameForDriver(SCH_ITEM *aItem)
Returns the candidate net name for a driver.
int assignNewNetCode(SCH_CONNECTION &aConnection)
Helper to assign a new net code to a connection.
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::vector< CONNECTION_SUBGRAPH * > m_driver_subgraphs
const NET_MAP & GetNetMap() const
void AddItem(SCH_ITEM *aItem)
Adds a new item to the subgraph.
bool m_strong_driver
True if the driver is "strong": a label or power object.
std::vector< SCH_ITEM * > m_drivers
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
SCH_SHEET_PATH.
CONNECTION_SUBGRAPH * FindFirstSubgraphByName(const wxString &aNetName)
Retrieves a subgraph for the given net name, if one exists.
std::vector< SCH_HIERLABEL * > m_hier_ports
std::map< wxString, std::vector< const CONNECTION_SUBGRAPH * > > m_global_label_cache
void assignNetCodesToBus(SCH_CONNECTION *aConnection)
Ensures all members of the bus connection have a valid net code assigned.
std::vector< std::pair< SCH_SHEET_PATH, SCH_PIN * > > m_invisible_power_pins
static bool m_allowRealTime
CONNECTION_SUBGRAPH * m_absorbed_by
If this subgraph is absorbed, points to the absorbing (and valid) subgraph.
std::map< NET_NAME_CODE, std::vector< CONNECTION_SUBGRAPH * > > NET_MAP
Associates a NET_CODE_NAME with all the subgraphs in that net.
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
SCH_SHEET_LIST m_sheetList
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< SCH_ITEM * > GetBusLabels() const
Returns all the bus labels attached to this subgraph (if any)
std::map< wxString, int > m_bus_name_to_code_map
The common library.
std::map< wxString, int > m_net_name_to_code_map
CONNECTION_SUBGRAPH * m_hier_parent
CONNECTION_SUBGRAPH * GetSubgraphForItem(SCH_ITEM *aItem)
SCH_ITEM * m_no_connect
No-connect item in graph, if any.
std::map< std::pair< SCH_SHEET_PATH, wxString >, std::vector< const CONNECTION_SUBGRAPH * > > m_local_label_cache
std::vector< const CONNECTION_SUBGRAPH * > GetBusesNeedingMigration()
Determines which subgraphs have more than one conflicting bus label.
bool ercCheckLabels(const CONNECTION_SUBGRAPH *aSubgraph)
Checks one subgraph for proper connection of labels.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:194
std::map< SCH_ITEM *, CONNECTION_SUBGRAPH * > m_item_to_subgraph_map
int RunERC()
Runs electrical rule checks on the connectivity graph.
wxString GetNetName() const
Returns the fully-qualified net name for this subgraph (if one exists)
static SCH_CONNECTION * matchBusMember(SCH_CONNECTION *aBusConnection, SCH_CONNECTION *aSearch)
Search for a matching bus member inside a bus connection.
bool ercCheckBusToBusConflicts(const CONNECTION_SUBGRAPH *aSubgraph)
Checks one subgraph for conflicting connections between two bus items.
std::unordered_map< SCH_ITEM *, wxString > m_driver_name_cache
A cache of escaped netnames from schematic items.
void UpdateItemConnections()
Updates all items to match the driver connection.