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 SCH_EDIT_FRAME;
40 class SCH_HIERLABEL;
41 class SCH_PIN;
42 class SCH_SHEET_PIN;
43 
44 
59 {
60 public:
61  enum class PRIORITY
62  {
63  INVALID = -1,
64  NONE = 0,
65  PIN,
66  SHEET_PIN,
67  HIER_LABEL,
69  POWER_PIN,
70  GLOBAL
71  };
72 
73  explicit CONNECTION_SUBGRAPH( SCH_EDIT_FRAME* aFrame ) :
74  m_dirty( false ), m_absorbed( false ), m_absorbed_by( nullptr ), m_code( -1 ),
75  m_multiple_drivers( false ), m_strong_driver( false ), m_local_driver( false ),
76  m_no_connect( nullptr ), m_bus_entry( nullptr ), m_driver( nullptr ), m_frame( aFrame ),
77  m_driver_connection( nullptr ), m_hier_parent( nullptr )
78  {}
79 
80  ~CONNECTION_SUBGRAPH() = default;
81 
91  bool ResolveDrivers( bool aCreateMarkers = false );
92 
96  wxString GetNetName() const;
97 
99  std::vector<SCH_ITEM*> GetBusLabels() const;
100 
102  wxString GetNameForDriver( SCH_ITEM* aItem ) const;
103 
105  void Absorb( CONNECTION_SUBGRAPH* aOther );
106 
108  void AddItem( SCH_ITEM* aItem );
109 
111  void UpdateItemConnections();
112 
127  static PRIORITY GetDriverPriority( SCH_ITEM* aDriver );
128 
129  bool m_dirty;
130 
133 
136 
137  long m_code;
138 
145 
148 
151 
154 
157 
158  std::vector<SCH_ITEM*> m_items;
159 
160  std::vector<SCH_ITEM*> m_drivers;
161 
163 
165 
166  // Needed for m_userUnits for now; maybe refactor later
168 
171 
180  std::unordered_map< std::shared_ptr<SCH_CONNECTION>,
181  std::unordered_set<CONNECTION_SUBGRAPH*> > m_bus_neighbors;
182 
188  std::unordered_map< std::shared_ptr<SCH_CONNECTION>,
189  std::unordered_set<CONNECTION_SUBGRAPH*> > m_bus_parents;
190 
191  // Cache for lookup of any hierarchical (sheet) pins on this subgraph (for referring down)
192  std::vector<SCH_SHEET_PIN*> m_hier_pins;
193 
194  // Cache for lookup of any hierarchical ports on this subgraph (for referring up)
195  std::vector<SCH_HIERLABEL*> m_hier_ports;
196 
197  // If not null, this indicates the subgraph on a higher level sheet that is linked to this one
199 };
200 
202 typedef std::pair<wxString, int> NET_NAME_CODE;
203 
205 typedef std::map<NET_NAME_CODE, std::vector<CONNECTION_SUBGRAPH*>> NET_MAP;
206 
211 {
212 public:
214  : m_last_net_code( 1 ),
215  m_last_bus_code( 1 ),
217  m_frame( aFrame )
218  {}
219 
221  {
222  Reset();
223  }
224 
225  void Reset();
226 
233  void Recalculate( const SCH_SHEET_LIST& aSheetList, bool aUnconditional = false );
234 
241  std::shared_ptr<BUS_ALIAS> GetBusAlias( const wxString& aName );
242 
250  std::vector<const CONNECTION_SUBGRAPH*> GetBusesNeedingMigration();
251 
261  int RunERC( const ERC_SETTINGS& aSettings, bool aCreateMarkers = true );
262 
263  const NET_MAP& GetNetMap() const { return m_net_code_to_subgraphs_map; }
264 
265  // TODO(JE) Remove this when pressure valve is removed
266  static bool m_allowRealTime;
267 
268 private:
269 
270  std::unordered_set<SCH_ITEM*> m_items;
271 
272  // The owner of all CONNECTION_SUBGRAPH objects
273  std::vector<CONNECTION_SUBGRAPH*> m_subgraphs;
274 
275  // Cache of a subset of m_subgraphs
276  std::vector<CONNECTION_SUBGRAPH*> m_driver_subgraphs;
277 
278  // Cache to lookup subgraphs in m_driver_subgraphs by sheet path
279  std::unordered_map<SCH_SHEET_PATH,
280  std::vector<CONNECTION_SUBGRAPH*>> m_sheet_to_subgraphs_map;
281 
282  std::vector<std::pair<SCH_SHEET_PATH, SCH_PIN*>> m_invisible_power_pins;
283 
284  std::unordered_map< wxString, std::shared_ptr<BUS_ALIAS> > m_bus_alias_cache;
285 
286  std::map<wxString, int> m_net_name_to_code_map;
287 
288  std::map<wxString, int> m_bus_name_to_code_map;
289 
290  std::map<wxString, std::vector<const CONNECTION_SUBGRAPH*>> m_global_label_cache;
291 
292  std::map< std::pair<SCH_SHEET_PATH, wxString>,
293  std::vector<const CONNECTION_SUBGRAPH*> > m_local_label_cache;
294 
295  std::unordered_map<wxString,
296  std::vector<CONNECTION_SUBGRAPH*>> m_net_name_to_subgraphs_map;
297 
299 
301 
303 
305 
306  std::mutex m_item_mutex;
307 
308  // Needed for m_userUnits for now; maybe refactor later
310 
339  const std::vector<SCH_ITEM*>& aItemList );
340 
354  void buildConnectionGraph();
355 
361  int assignNewNetCode( SCH_CONNECTION& aConnection );
362 
367  void assignNetCodesToBus( SCH_CONNECTION* aConnection );
368 
375  void propagateToNeighbors( CONNECTION_SUBGRAPH* aSubgraph );
376 
387  static SCH_CONNECTION* matchBusMember( SCH_CONNECTION* aBusConnection,
388  SCH_CONNECTION* aSearch );
389 
390  void recacheSubgraphName( CONNECTION_SUBGRAPH* aSubgraph, const wxString& aOldName );
391 
401  bool ercCheckBusToNetConflicts( const CONNECTION_SUBGRAPH* aSubgraph,
402  bool aCreateMarkers );
403 
415  bool ercCheckBusToBusConflicts( const CONNECTION_SUBGRAPH* aSubgraph,
416  bool aCreateMarkers );
417 
432  bool aCreateMarkers );
433 
444  bool ercCheckNoConnects( const CONNECTION_SUBGRAPH* aSubgraph,
445  bool aCreateMarkers );
446 
457  bool ercCheckLabels( const CONNECTION_SUBGRAPH* aSubgraph, bool aCreateMarkers,
458  bool aCheckGlobalLabels );
459 
460 };
461 
462 #endif
CONNECTION_SUBGRAPH(SCH_EDIT_FRAME *aFrame)
SCH_SHEET_PATH m_sheet
SCH_SHEET_LIST.
SCH_CONNECTION * m_driver_connection
Cache for driver connection.
void propagateToNeighbors(CONNECTION_SUBGRAPH *aSubgraph)
Updates all neighbors of a subgraph with this one's connectivity info.
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
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...
int RunERC(const ERC_SETTINGS &aSettings, bool aCreateMarkers=true)
Runs electrical rule checks on the connectivity graph.
SCH_ITEM * m_bus_entry
Bus entry in graph, if any.
bool ercCheckLabels(const CONNECTION_SUBGRAPH *aSubgraph, bool aCreateMarkers, bool aCheckGlobalLabels)
Checks one subgraph for proper connection of labels.
SCH_EDIT_FRAME * m_frame
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.
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.
std::mutex m_item_mutex
NET_MAP m_net_code_to_subgraphs_map
Schematic editor (Eeschema) main window.
CONNECTION_GRAPH(SCH_EDIT_FRAME *aFrame)
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.
bool ercCheckNoConnects(const CONNECTION_SUBGRAPH *aSubgraph, bool aCreateMarkers)
Checks one subgraph for proper presence or absence of no-connect symbols.
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)
int assignNewNetCode(SCH_CONNECTION &aConnection)
Helper to assign a new net code to a connection.
bool ercCheckBusToBusConflicts(const CONNECTION_SUBGRAPH *aSubgraph, bool aCreateMarkers)
Checks one subgraph for conflicting connections between two bus items.
std::vector< SCH_ITEM * > m_items
SCH_EDIT_FRAME * m_frame
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:75
Container for ERC settings.
Definition: erc_settings.h:30
SCH_SHEET_PATH.
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.
bool ercCheckBusToNetConflicts(const CONNECTION_SUBGRAPH *aSubgraph, bool aCreateMarkers)
Checks one subgraph for conflicting connections between net and bus labels.
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).
bool ercCheckBusToBusEntryConflicts(const CONNECTION_SUBGRAPH *aSubgraph, bool aCreateMarkers)
Checks one subgraph for conflicting bus entry to bus connections.
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
std::unordered_set< SCH_ITEM * > m_items
CONNECTION_SUBGRAPH * m_hier_parent
void updateItemConnectivity(SCH_SHEET_PATH aSheet, const std::vector< SCH_ITEM * > &aItemList)
Updates the graphical connectivity between items (i.e.
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.
SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:136
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.
wxString GetNameForDriver(SCH_ITEM *aItem) const
Returns the candidate net name for a driver.
void UpdateItemConnections()
Updates all items to match the driver connection.