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