KiCad PCB EDA Suite
netlist_exporter.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) 1992-2017 jp.charras at wanadoo.fr
5  * Copyright (C) 2013-2017 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.TXT for contributors.
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
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
26 
31 #include <fctsys.h>
32 #include <confirm.h>
33 #include <kicad_string.h>
34 #include <gestfich.h>
35 #include <pgm_base.h>
36 
37 #include <sch_reference_list.h>
38 #include <class_netlist_object.h>
39 #include <class_library.h>
40 #include <lib_pin.h>
41 #include <sch_component.h>
42 #include <sch_text.h>
43 #include <sch_sheet.h>
44 
45 #include <netlist.h>
46 #include <netlist_exporter.h>
47 
48 
49 
50 wxString NETLIST_EXPORTER::MakeCommandLine( const wxString& aFormatString,
51  const wxString& aTempfile, const wxString& aFinalFile, const wxString& aProjectPath )
52 {
53  // Expand format symbols in the command line:
54  // %B => base filename of selected output file, minus path and extension.
55  // %P => project directory name, without trailing '/' or '\'.
56  // %I => full filename of the input file (the intermediate net file).
57  // %O => complete filename and path (but without extension) of the user chosen output file.
58 
59  wxString ret = aFormatString;
60  wxFileName in = aTempfile;
61  wxFileName out = aFinalFile;
62 
63  ret.Replace( wxT( "%P" ), aProjectPath.GetData(), true );
64  ret.Replace( wxT( "%B" ), out.GetName().GetData(), true );
65  ret.Replace( wxT( "%I" ), in.GetFullPath().GetData(), true );
66  ret.Replace( wxT( "%O" ), out.GetFullPath().GetData(), true );
67 
68  // Use Unix like notation, which always works
69  ret.Replace( wxT( "\\" ), "/", true );
70 
71  return ret;
72 }
73 
74 
75 void NETLIST_EXPORTER::sprintPinNetName( wxString& aResult,
76  const wxString& aNetNameFormat, NETLIST_OBJECT* aPin,
77  bool aUseNetcodeAsNetName )
78 {
79  int netcode = aPin->GetNet();
80 
81  // Not wxString::Clear(), which would free memory. We want the worst
82  // case wxString memory to grow to avoid reallocation from within the
83  // caller's loop.
84  aResult.Empty();
85 
86  if( netcode != 0 && aPin->GetConnectionType() == PAD_CONNECT )
87  {
88  if( aUseNetcodeAsNetName )
89  {
90  aResult.Printf( wxT("%d"), netcode );
91  }
92  else
93  {
94  aResult = aPin->GetNetName();
95 
96  if( aResult.IsEmpty() ) // No net name: give a name from net code
97  aResult.Printf( aNetNameFormat.GetData(), netcode );
98  }
99  }
100 }
101 
102 
104 {
105  wxString ref;
106 
107  // continue searching from the middle of a linked list (the draw list)
108  for( ; aItem; aItem = aItem->Next() )
109  {
110  if( aItem->Type() != SCH_COMPONENT_T )
111  continue;
112 
113  // found next component
114  SCH_COMPONENT* comp = (SCH_COMPONENT*) aItem;
115 
116  // Power symbols and other components which have the reference starting
117  // with "#" are not included in netlist (pseudo or virtual components)
118  ref = comp->GetRef( aSheetPath );
119 
120  if( ref[0] == wxChar( '#' ) )
121  continue;
122 
123  // if( Component->m_FlagControlMulti == 1 )
124  // continue; /* yes */
125  // removed because with multiple instances of one schematic
126  // (several sheets pointing to 1 screen), this will be erroneously be
127  // toggled.
128 
129  LIB_PART* part = comp->GetPartRef().lock().get();
130 
131  if( !part )
132  continue;
133 
134  // If component is a "multi parts per package" type
135  if( part->GetUnitCount() > 1 )
136  {
137  // test if this reference has already been processed, and if so skip
138  if( m_ReferencesAlreadyFound.Lookup( ref ) )
139  continue;
140  }
141 
142  // record the usage of this library component entry.
143  m_LibParts.insert( part ); // rejects non-unique pointers
144 
145  return comp;
146  }
147 
148  return NULL;
149 }
150 
151 
153 static bool sortPinsByNum( NETLIST_OBJECT* aPin1, NETLIST_OBJECT* aPin2 )
154 {
155  // return "lhs < rhs"
156  return RefDesStringCompare( aPin1->GetPinNumText(), aPin2->GetPinNumText() ) < 0;
157 }
158 
159 
161  EDA_ITEM* aItem, SCH_SHEET_PATH* aSheetPath )
162 {
163  wxString ref;
164 
165  m_SortedComponentPinList.clear();
166 
167  // continue searching from the middle of a linked list (the draw list)
168  for( ; aItem; aItem = aItem->Next() )
169  {
170  if( aItem->Type() != SCH_COMPONENT_T )
171  continue;
172 
173  // found next component
174  SCH_COMPONENT* comp = (SCH_COMPONENT*) aItem;
175 
176  // Power symbols and other components which have the reference starting
177  // with "#" are not included in netlist (pseudo or virtual components)
178  ref = comp->GetRef( aSheetPath );
179 
180  if( ref[0] == wxChar( '#' ) )
181  continue;
182 
183  // if( Component->m_FlagControlMulti == 1 )
184  // continue; /* yes */
185  // removed because with multiple instances of one schematic
186  // (several sheets pointing to 1 screen), this will be erroneously be
187  // toggled.
188 
189  LIB_PART* part = comp->GetPartRef().lock().get();
190 
191  if( !part )
192  continue;
193 
194  // If component is a "multi parts per package" type
195  if( part->GetUnitCount() > 1 )
196  {
197  // test if this reference has already been processed, and if so skip
198  if( m_ReferencesAlreadyFound.Lookup( ref ) )
199  continue;
200 
201  // Collect all pins for this reference designator by searching
202  // the entire design for other parts with the same reference designator.
203  // This is only done once, it would be too expensive otherwise.
204  findAllUnitsOfComponent( comp, part, aSheetPath );
205  }
206 
207  else // entry->GetUnitCount() <= 1 means one part per package
208  {
209  LIB_PINS pins; // constructed once here
210 
211  part->GetPins( pins, comp->GetUnitSelection( aSheetPath ), comp->GetConvert() );
212 
213  for( size_t i = 0; i < pins.size(); i++ )
214  {
215  LIB_PIN* pin = pins[i];
216 
217  wxASSERT( pin->Type() == LIB_PIN_T );
218 
219  addPinToComponentPinList( comp, aSheetPath, pin );
220  }
221  }
222 
223  // Sort pins in m_SortedComponentPinList by pin number
224  sort( m_SortedComponentPinList.begin(),
226 
227  // Remove duplicate Pins in m_SortedComponentPinList
229 
230  // record the usage of this library component entry.
231  m_LibParts.insert( part ); // rejects non-unique pointers
232 
233  return comp;
234  }
235 
236  return NULL;
237 }
238 
239 
241  SCH_SHEET_PATH* aSheetPath, LIB_PIN* aPin )
242 {
243  // Search the PIN description for Pin in g_NetObjectslist
244  for( unsigned ii = 0; ii < m_masterList->size(); ii++ )
245  {
246  NETLIST_OBJECT* pin = m_masterList->GetItem( ii );
247 
248  if( pin->m_Type != NET_PIN )
249  continue;
250 
251  if( pin->m_Link != aComponent )
252  continue;
253 
254  if( pin->m_PinNum != aPin->GetNumber() )
255  continue;
256 
257  // most expensive test at the end.
258  if( pin->m_SheetPath != *aSheetPath )
259  continue;
260 
261  m_SortedComponentPinList.push_back( pin );
262 
263  if( m_SortedComponentPinList.size() >= MAXPIN )
264  {
265  // Log message for Internal error
266  DisplayError( NULL, wxT( "addPinToComponentPinList err: MAXPIN reached" ) );
267  }
268 
269  return true; // we're done, we appended.
270  }
271 
272  return false;
273 }
274 
275 
277 {
278  for( unsigned ii = 0; ii < m_SortedComponentPinList.size(); ii++ )
279  {
280  if( m_SortedComponentPinList[ii] == NULL ) /* already deleted */
281  continue;
282 
283  /* Search for duplicated pins
284  * If found, remove duplicates. The priority is to keep connected pins
285  * and remove unconnected
286  * - So this allows (for instance when using multi op amps per package
287  * - to connect only one op amp to power
288  * Because the pin list is sorted by m_PinNum value, duplicated pins
289  * are necessary successive in list
290  */
291  int idxref = ii;
292  for( unsigned jj = ii + 1; jj < m_SortedComponentPinList.size(); jj++ )
293  {
294  if( m_SortedComponentPinList[jj] == NULL ) // Already removed
295  continue;
296 
297  // if other pin num, stop search,
298  // because all pins having the same number are consecutive in list.
299  if( m_SortedComponentPinList[idxref]->m_PinNum != m_SortedComponentPinList[jj]->m_PinNum )
300  break;
301 
302  if( m_SortedComponentPinList[idxref]->GetConnectionType() == PAD_CONNECT )
303  {
304  m_SortedComponentPinList[jj]->m_Flag = 1;
305  m_SortedComponentPinList[jj] = NULL;
306  }
307  else /* the reference pin is not connected: remove this pin if the
308  * other pin is connected */
309  {
310  if( m_SortedComponentPinList[jj]->GetConnectionType() == PAD_CONNECT )
311  {
312  m_SortedComponentPinList[idxref]->m_Flag = 1;
313  m_SortedComponentPinList[idxref] = NULL;
314  idxref = jj;
315  }
316  else // the 2 pins are not connected: remove the tested pin,
317  { // and continue ...
318  m_SortedComponentPinList[jj]->m_Flag = 1;
319  m_SortedComponentPinList[jj] = NULL;
320  }
321  }
322  }
323  }
324 }
325 
326 
328  LIB_PART* aEntry, SCH_SHEET_PATH* aSheetPath )
329 {
330  wxString ref = aComponent->GetRef( aSheetPath );
331  wxString ref2;
332 
333  SCH_SHEET_LIST sheetList( g_RootSheet );
334 
335  for( unsigned i = 0; i < sheetList.size(); i++ )
336  {
337  for( EDA_ITEM* item = sheetList[i].LastDrawList(); item; item = item->Next() )
338  {
339  if( item->Type() != SCH_COMPONENT_T )
340  continue;
341 
342  SCH_COMPONENT* comp2 = (SCH_COMPONENT*) item;
343 
344  ref2 = comp2->GetRef( &sheetList[i] );
345 
346  if( ref2.CmpNoCase( ref ) != 0 )
347  continue;
348 
349  int unit2 = comp2->GetUnitSelection( &sheetList[i] ); // slow
350 
351  for( LIB_PIN* pin = aEntry->GetNextPin(); pin; pin = aEntry->GetNextPin( pin ) )
352  {
353  wxASSERT( pin->Type() == LIB_PIN_T );
354 
355  if( pin->GetUnit() && pin->GetUnit() != unit2 )
356  continue;
357 
358  if( pin->GetConvert() && pin->GetConvert() != comp2->GetConvert() )
359  continue;
360 
361  // A suitable pin is found: add it to the current list
362  addPinToComponentPinList( comp2, &sheetList[i], pin );
363  }
364  }
365  }
366 }
367 
Definition of the SCH_SHEET class for Eeschema.
Class SCH_SHEET_LIST.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
NET_CONNECTION_T GetConnectionType() const
int RefDesStringCompare(const wxString &strFWord, const wxString &strSWord)
Function RefDesStringCompare acts just like the strcmp function but treats numbers within the string ...
Definition: string.cpp:365
wxString GetNetName(bool adoptTimestamp=false) const
Function GetNetName.
bool Lookup(const wxString &aString)
Function Lookup returns true if aString already exists in the set, otherwise returns false and adds a...
PART_REF & GetPartRef()
This file is part of the common library TODO brief description.
UNIQUE_STRINGS m_ReferencesAlreadyFound
Used for "multi parts per package" components, avoids processing a lib component more than once...
NETLIST_OBJECT * GetItem(unsigned aIdx) const
Acces to an item in list.
This file is part of the common library.
static void sprintPinNetName(wxString &aResult, const wxString &aNetNameFormat, NETLIST_OBJECT *aPin, bool aUseNetcodeAsNetName=false)
Function sprintPinNetName formats the net name for aPin using aNetNameFormat into aResult...
int GetUnitSelection(SCH_SHEET_PATH *aSheet)
long GetNumber() const
Definition: lib_pin.h:173
#define MAXPIN
Definition: netlist.h:53
SCH_SHEET_PATH m_SheetPath
EDA_ITEM * Next() const
Definition: base_struct.h:206
wxString GetPinNumText()
Function GetPinNum returns a pin number in wxString form.
SCH_COMPONENT * findNextComponent(EDA_ITEM *aItem, SCH_SHEET_PATH *aSheetPath)
NETLIST_ITEM_T m_Type
void findAllUnitsOfComponent(SCH_COMPONENT *aComponent, LIB_PART *aEntry, SCH_SHEET_PATH *aSheetPath)
Function findAllUnitsOfComponent is used for "multiple parts per package" components.
NETLIST_OBJECT_LIST * m_masterList
static wxString MakeCommandLine(const wxString &aFormatString, const wxString &aTempfile, const wxString &aFinalFile, const wxString &aProjectDirectory)
Function MakeCommandLine builds up a string that describes a command line for executing a child proce...
static bool sortPinsByNum(NETLIST_OBJECT *aPin1, NETLIST_OBJECT *aPin2)
Comparison routine for sorting by pin numbers.
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
std::set< LIB_PART *, LIB_PART_LESS_THAN > m_LibParts
unique library parts used. LIB_PART items are sorted by names
int GetConvert() const
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:54
Class LIB_PART defines a library part object.
SCH_COMPONENT * findNextComponentAndCreatePinList(EDA_ITEM *aItem, SCH_SHEET_PATH *aSheetPath)
Function findNextComponentAndCreatePinList finds a component from the DrawList and builds its pin lis...
Class SCH_SHEET_PATH.
int GetUnitCount() const
LIB_PIN * GetNextPin(LIB_PIN *aItem=NULL)
Return the next pin object from the draw list.
Definition of the NETLIST_OBJECT class.
NETLIST_OBJECTS m_SortedComponentPinList
no ownership
const wxString GetRef(const SCH_SHEET_PATH *sheet)
Function GetRef returns the reference, for the given sheet path.
Definition the SCH_COMPONENT class for Eeschema.
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_draw_item.h:70
see class PGM_BASE
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:151
bool addPinToComponentPinList(SCH_COMPONENT *Component, SCH_SHEET_PATH *sheet, LIB_PIN *PinEntry)
Function addPinToComponentPinList adds a new pin description to the pin list m_SortedComponentPinList...
Definition for part library class.
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:69
Implementation of the label properties dialog.
void eraseDuplicatePins()
Function eraseDuplicatePins erase duplicate Pins from m_SortedComponentPinList (i.e.