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_library.h>
39 
40 #include <netlist.h>
41 #include <netlist_exporter.h>
42 
43 
44 
45 wxString NETLIST_EXPORTER::MakeCommandLine( const wxString& aFormatString,
46  const wxString& aNetlistFile, const wxString& aFinalFile, const wxString& aProjectPath )
47 {
48  // Expand format symbols in the command line:
49  // %B => base filename of selected output file, minus path and extension.
50  // %P => project directory name, without trailing '/' or '\'.
51  // %I => full filename of the input file (the intermediate net file).
52  // %O => complete filename and path (but without extension) of the user chosen output file.
53 
54  wxString ret = aFormatString;
55  wxFileName in = aNetlistFile;
56  wxFileName out = aFinalFile;
57  wxString str_out = out.GetFullPath();
58 
59  ret.Replace( "%P", aProjectPath, true );
60  ret.Replace( "%B", out.GetName(), true );
61  ret.Replace( "%I", in.GetFullPath(), true );
62 
63 #ifdef __WINDOWS__
64  // A ugly hack to run xsltproc that has a serious bug on Window since a long time:
65  // the filename given after -o option (output filename) cannot use '\' in filename
66  // so replace if by '/' if possible (I mean if the filename does not start by "\\"
67  // that is a filename on a Windows server)
68 
69  if( !str_out.StartsWith( "\\\\" ) )
70  str_out.Replace( "\\", "/" );
71 #endif
72 
73  ret.Replace( "%O", str_out, true );
74 
75  return ret;
76 }
77 
78 
79 void NETLIST_EXPORTER::sprintPinNetName( wxString& aResult,
80  const wxString& aNetNameFormat, NETLIST_OBJECT* aPin,
81  bool aUseNetcodeAsNetName )
82 {
83  int netcode = aPin->GetNet();
84 
85  // Not wxString::Clear(), which would free memory. We want the worst
86  // case wxString memory to grow to avoid reallocation from within the
87  // caller's loop.
88  aResult.Empty();
89 
90  if( netcode != 0 && aPin->GetConnectionType() == PAD_CONNECT )
91  {
92  if( aUseNetcodeAsNetName )
93  {
94  aResult.Printf( "%d", netcode );
95  }
96  else
97  {
98  aResult = aPin->GetNetName();
99 
100  if( aResult.IsEmpty() ) // No net name: give a name from net code
101  aResult.Printf( aNetNameFormat.GetData(), netcode );
102  }
103  }
104 }
105 
106 
108 {
109  wxString ref;
110 
111  // continue searching from the middle of a linked list (the draw list)
112  for( ; aItem; aItem = aItem->Next() )
113  {
114  if( aItem->Type() != SCH_COMPONENT_T )
115  continue;
116 
117  // found next component
118  SCH_COMPONENT* comp = (SCH_COMPONENT*) aItem;
119 
120  // Power symbols and other components which have the reference starting
121  // with "#" are not included in netlist (pseudo or virtual components)
122  ref = comp->GetRef( aSheetPath );
123 
124  if( ref[0] == wxChar( '#' ) )
125  continue;
126 
127  // if( Component->m_FlagControlMulti == 1 )
128  // continue; /* yes */
129  // removed because with multiple instances of one schematic
130  // (several sheets pointing to 1 screen), this will be erroneously be
131  // toggled.
132 
133  LIB_PART* part = comp->GetPartRef().lock().get();
134 
135  if( !part )
136  continue;
137 
138  // If component is a "multi parts per package" type
139  if( part->GetUnitCount() > 1 )
140  {
141  // test if this reference has already been processed, and if so skip
142  if( m_ReferencesAlreadyFound.Lookup( ref ) )
143  continue;
144  }
145 
146  // record the usage of this library component entry.
147  m_LibParts.insert( part ); // rejects non-unique pointers
148 
149  return comp;
150  }
151 
152  return NULL;
153 }
154 
155 
157 static bool sortPinsByNum( NETLIST_OBJECT* aPin1, NETLIST_OBJECT* aPin2 )
158 {
159  // return "lhs < rhs"
160  return RefDesStringCompare( aPin1->GetPinNumText(), aPin2->GetPinNumText() ) < 0;
161 }
162 
163 
165  EDA_ITEM* aItem, SCH_SHEET_PATH* aSheetPath )
166 {
167  wxString ref;
168 
169  m_SortedComponentPinList.clear();
170 
171  // continue searching from the middle of a linked list (the draw list)
172  for( ; aItem; aItem = aItem->Next() )
173  {
174  if( aItem->Type() != SCH_COMPONENT_T )
175  continue;
176 
177  // found next component
178  SCH_COMPONENT* comp = (SCH_COMPONENT*) aItem;
179 
180  // Power symbols and other components which have the reference starting
181  // with "#" are not included in netlist (pseudo or virtual components)
182  ref = comp->GetRef( aSheetPath );
183 
184  if( ref[0] == wxChar( '#' ) )
185  continue;
186 
187  // if( Component->m_FlagControlMulti == 1 )
188  // continue; /* yes */
189  // removed because with multiple instances of one schematic
190  // (several sheets pointing to 1 screen), this will be erroneously be
191  // toggled.
192 
193  LIB_PART* part = comp->GetPartRef().lock().get();
194 
195  if( !part )
196  continue;
197 
198  // If component is a "multi parts per package" type
199  if( part->GetUnitCount() > 1 )
200  {
201  // test if this reference has already been processed, and if so skip
202  if( m_ReferencesAlreadyFound.Lookup( ref ) )
203  continue;
204 
205  // Collect all pins for this reference designator by searching
206  // the entire design for other parts with the same reference designator.
207  // This is only done once, it would be too expensive otherwise.
208  findAllUnitsOfComponent( comp, part, aSheetPath );
209  }
210 
211  else // entry->GetUnitCount() <= 1 means one part per package
212  {
213  LIB_PINS pins; // constructed once here
214 
215  part->GetPins( pins, comp->GetUnitSelection( aSheetPath ), comp->GetConvert() );
216 
217  for( size_t i = 0; i < pins.size(); i++ )
218  {
219  LIB_PIN* pin = pins[i];
220 
221  wxASSERT( pin->Type() == LIB_PIN_T );
222 
223  addPinToComponentPinList( comp, aSheetPath, pin );
224  }
225  }
226 
227  // Sort pins in m_SortedComponentPinList by pin number
228  sort( m_SortedComponentPinList.begin(),
230 
231  // Remove duplicate Pins in m_SortedComponentPinList
233 
234  // record the usage of this library component entry.
235  m_LibParts.insert( part ); // rejects non-unique pointers
236 
237  return comp;
238  }
239 
240  return NULL;
241 }
242 
243 
245  SCH_SHEET_PATH* aSheetPath, LIB_PIN* aPin )
246 {
247  // Search the PIN description for Pin in g_NetObjectslist
248  for( unsigned ii = 0; ii < m_masterList->size(); ii++ )
249  {
250  NETLIST_OBJECT* pin = m_masterList->GetItem( ii );
251 
252  if( pin->m_Type != NET_PIN )
253  continue;
254 
255  if( pin->m_Link != aComponent )
256  continue;
257 
258  if( pin->m_PinNum != aPin->GetNumber() )
259  continue;
260 
261  // most expensive test at the end.
262  if( pin->m_SheetPath != *aSheetPath )
263  continue;
264 
265  m_SortedComponentPinList.push_back( pin );
266 
267  if( m_SortedComponentPinList.size() >= MAXPIN )
268  {
269  // Log message for Internal error
270  DisplayError( NULL, wxT( "addPinToComponentPinList err: MAXPIN reached" ) );
271  }
272 
273  return true; // we're done, we appended.
274  }
275 
276  return false;
277 }
278 
279 
281 {
282  for( unsigned ii = 0; ii < m_SortedComponentPinList.size(); ii++ )
283  {
284  if( m_SortedComponentPinList[ii] == NULL ) /* already deleted */
285  continue;
286 
287  /* Search for duplicated pins
288  * If found, remove duplicates. The priority is to keep connected pins
289  * and remove unconnected
290  * - So this allows (for instance when using multi op amps per package
291  * - to connect only one op amp to power
292  * Because the pin list is sorted by m_PinNum value, duplicated pins
293  * are necessary successive in list
294  */
295  int idxref = ii;
296  for( unsigned jj = ii + 1; jj < m_SortedComponentPinList.size(); jj++ )
297  {
298  if( m_SortedComponentPinList[jj] == NULL ) // Already removed
299  continue;
300 
301  // if other pin num, stop search,
302  // because all pins having the same number are consecutive in list.
303  if( m_SortedComponentPinList[idxref]->m_PinNum != m_SortedComponentPinList[jj]->m_PinNum )
304  break;
305 
306  if( m_SortedComponentPinList[idxref]->GetConnectionType() == PAD_CONNECT )
307  {
308  m_SortedComponentPinList[jj]->m_Flag = 1;
309  m_SortedComponentPinList[jj] = NULL;
310  }
311  else /* the reference pin is not connected: remove this pin if the
312  * other pin is connected */
313  {
314  if( m_SortedComponentPinList[jj]->GetConnectionType() == PAD_CONNECT )
315  {
316  m_SortedComponentPinList[idxref]->m_Flag = 1;
317  m_SortedComponentPinList[idxref] = NULL;
318  idxref = jj;
319  }
320  else // the 2 pins are not connected: remove the tested pin,
321  { // and continue ...
322  m_SortedComponentPinList[jj]->m_Flag = 1;
323  m_SortedComponentPinList[jj] = NULL;
324  }
325  }
326  }
327  }
328 }
329 
330 
332  LIB_PART* aEntry, SCH_SHEET_PATH* aSheetPath )
333 {
334  wxString ref = aComponent->GetRef( aSheetPath );
335  wxString ref2;
336 
337  SCH_SHEET_LIST sheetList( g_RootSheet );
338 
339  for( unsigned i = 0; i < sheetList.size(); i++ )
340  {
341  for( EDA_ITEM* item = sheetList[i].LastDrawList(); item; item = item->Next() )
342  {
343  if( item->Type() != SCH_COMPONENT_T )
344  continue;
345 
346  SCH_COMPONENT* comp2 = (SCH_COMPONENT*) item;
347 
348  ref2 = comp2->GetRef( &sheetList[i] );
349 
350  if( ref2.CmpNoCase( ref ) != 0 )
351  continue;
352 
353  int unit2 = comp2->GetUnitSelection( &sheetList[i] ); // slow
354 
355  for( LIB_PIN* pin = aEntry->GetNextPin(); pin; pin = aEntry->GetNextPin( pin ) )
356  {
357  wxASSERT( pin->Type() == LIB_PIN_T );
358 
359  if( pin->GetUnit() && pin->GetUnit() != unit2 )
360  continue;
361 
362  if( pin->GetConvert() && pin->GetConvert() != comp2->GetConvert() )
363  continue;
364 
365  // A suitable pin is found: add it to the current list
366  addPinToComponentPinList( comp2, &sheetList[i], pin );
367  }
368  }
369  }
370 }
371 
Class SCH_SHEET_LIST.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:209
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:466
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()
const wxString & GetPinNumText() const
Function GetPinNum returns a pin number in wxString form.
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)
#define MAXPIN
Definition: netlist.h:53
SCH_SHEET_PATH m_SheetPath
EDA_ITEM * Next() const
Definition: base_struct.h:217
static wxString MakeCommandLine(const wxString &aFormatString, const wxString &aNetlistFile, const wxString &aFinalFile, const wxString &aProjectDirectory)
Function MakeCommandLine builds up a string that describes a command line for executing a child proce...
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
const wxString & GetNumber() const
Definition: lib_pin.h:193
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
int GetNet() const
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:55
Define a library symbol 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.
const wxString GetRef(const SCH_SHEET_PATH *aSheet)
Return the reference for the given sheet path.
int GetUnitCount() const
LIB_PIN * GetNextPin(LIB_PIN *aItem=NULL)
Return the next pin object from the draw list.
NETLIST_OBJECTS m_SortedComponentPinList
yes ownership, connected items flat list
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_draw_item.h:60
see class PGM_BASE
size_t i
Definition: json11.cpp:597
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:162
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.
SCH_ITEM * m_Link
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:185
void eraseDuplicatePins()
Function eraseDuplicatePins erase duplicate Pins from m_SortedComponentPinList (i.e.