KiCad PCB EDA Suite
netlist_exporter_pspice.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-2013 jp.charras at wanadoo.fr
5  * Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 1992-2016 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 
27 #include <fctsys.h>
28 #include <build_version.h>
29 #include <confirm.h>
30 
31 #include <map>
32 #include <search_stack.h>
33 
34 #include <schframe.h>
35 #include <netlist.h>
36 #include <sch_reference_list.h>
37 #include <class_netlist_object.h>
38 
39 #include <wx/tokenzr.h>
40 #include <wx/regex.h>
41 
42 bool NETLIST_EXPORTER_PSPICE::WriteNetlist( const wxString& aOutFileName, unsigned aNetlistOptions )
43 {
44  FILE_OUTPUTFORMATTER outputFile( aOutFileName, wxT( "wt" ), '\'' );
45 
46  return Format( &outputFile, aNetlistOptions );
47 }
48 
50 {
51  // some chars are not accepted in netnames in spice netlists, because they are separators
52  // they are replaced an underscore or some other allowed char.
53  // Note: this is a static function
54 
55  aNetName.Replace( "(", "_" );
56  aNetName.Replace( ")", "_" );
57 }
58 
59 
60 bool NETLIST_EXPORTER_PSPICE::Format( OUTPUTFORMATTER* aFormatter, unsigned aCtl )
61 {
62  // Netlist options
63  const bool useNetcodeAsNetName = false;//aCtl & NET_USE_NETCODES_AS_NETNAMES;
64 
65  if( !ProcessNetlist( aCtl ) )
66  return false;
67 
68  aFormatter->Print( 0, ".title KiCad schematic\n" );
69 
70  // Write .include directives
71  for( auto lib : m_libraries )
72  {
73  wxString full_path;
74 
75  if( ( aCtl & NET_ADJUST_INCLUDE_PATHS ) && m_paths )
76  {
77  // Look for the library in known search locations
78  full_path = m_paths->FindValidPath( lib );
79 
80  if( full_path.IsEmpty() )
81  {
82  DisplayError( NULL, wxString::Format( _( "Could not find library file %s" ), lib ) );
83  full_path = lib;
84  }
85  }
86  else
87  full_path = lib; // just use the unaltered path
88 
89  aFormatter->Print( 0, ".include \"%s\"\n", (const char*) full_path.c_str() );
90  }
91 
92  for( const auto& item : m_spiceItems )
93  {
94  if( !item.m_enabled )
95  continue;
96 
97  // Save the node order
98  aFormatter->Print( 0, "%c%s ", item.m_primitive, (const char*) item.m_refName.c_str() );
99 
100  size_t pspiceNodes = item.m_pinSequence.empty() ? item.m_pins.size() : item.m_pinSequence.size();
101 
102  for( size_t ii = 0; ii < pspiceNodes; ii++ )
103  {
104  // Use the custom order if defined, otherwise use the standard pin order as defined in the compon
105  size_t activePinIndex = item.m_pinSequence.empty() ? ii : item.m_pinSequence[ii];
106  // Valid used Node Indexes are in the set
107  // {0,1,2,...m_item.m_pin.size()-1}
108  if( activePinIndex >= item.m_pins.size() )
109  {
110  wxASSERT_MSG( false, "Used an invalid pin number in node sequence" );
111  continue;
112  }
113 
114  NETLIST_OBJECT* pin = item.m_pins[activePinIndex];
115  assert( pin );
116  wxString netName = pin->GetNetName();
117 
118  if( useNetcodeAsNetName )
119  {
120  assert( m_netMap.count( netName ) );
121  aFormatter->Print( 0, "%d ", m_netMap[netName] );
122  }
123  else
124  {
125  sprintPinNetName( netName , wxT( "N-%.6d" ), pin, useNetcodeAsNetName );
126 
127  // Replace parenthesis with underscore to prevent parse issues with simulators
128  ReplaceForbiddenChars( netName );
129 
130  if( netName.IsEmpty() )
131  netName = wxT( "?" );
132 
133  aFormatter->Print( 0, "%s ", TO_UTF8( netName ) );
134  }
135  }
136 
137  aFormatter->Print( 0, "%s\n", (const char*) item.m_model.c_str() );
138  }
139 
140  // Print out all directives found in the text fields on the schematics
141  writeDirectives( aFormatter, aCtl );
142 
143  aFormatter->Print( 0, ".end\n" );
144 
145  return true;
146 }
147 
148 
150  SCH_COMPONENT* aComponent, unsigned aCtl )
151 {
152  SCH_FIELD* field = aComponent->FindField( GetSpiceFieldName( aField ) );
153  return field ? field->GetText() : GetSpiceFieldDefVal( aField, aComponent, aCtl );
154 }
155 
156 
158  SCH_COMPONENT* aComponent, unsigned aCtl )
159 {
160  switch( aField )
161  {
162  case SF_PRIMITIVE:
163  {
164  const wxString& refName = aComponent->GetField( REFERENCE )->GetText();
165  return refName.GetChar( 0 );
166  break;
167  }
168 
169  case SF_MODEL:
170  {
171  wxChar prim = aComponent->GetField( REFERENCE )->GetText().GetChar( 0 );
172  wxString value = aComponent->GetField( VALUE )->GetText();
173 
174  // Is it a passive component?
175  if( aCtl & NET_ADJUST_PASSIVE_VALS && ( prim == 'C' || prim == 'L' || prim == 'R' ) )
176  {
177  // Regular expression to match common formats used for passive parts description
178  // (e.g. 100k, 2k3, 1 uF)
179  wxRegEx passiveVal( "^([0-9\\. ]+)([fFpPnNuUmMkKgGtT]|M(e|E)(g|G))?([fFhH]|ohm)?([-1-9 ]*)$" );
180 
181  if( passiveVal.Matches( value ) )
182  {
183  wxString prefix( passiveVal.GetMatch( value, 1 ) );
184  wxString unit( passiveVal.GetMatch( value, 2 ) );
185  wxString suffix( passiveVal.GetMatch( value, 6 ) );
186 
187  prefix.Trim(); prefix.Trim( false );
188  unit.Trim(); unit.Trim( false );
189  suffix.Trim(); suffix.Trim( false );
190 
191  // Make 'mega' units comply with the Spice expectations
192  if( unit == "M" )
193  unit = "Meg";
194 
195  value = prefix + unit + suffix;
196  }
197  }
198 
199  return value;
200  break;
201  }
202 
203  case SF_ENABLED:
204  return wxString( "Y" );
205  break;
206 
207  case SF_NODE_SEQUENCE:
208  {
209  wxString nodeSeq;
210  std::vector<LIB_PIN*> pins;
211 
212  aComponent->GetPins( pins );
213 
214  for( auto pin : pins )
215  nodeSeq += pin->GetNumberString() + " ";
216 
217  nodeSeq.Trim();
218 
219  return nodeSeq;
220  break;
221  }
222 
223  case SF_LIB_FILE:
224  // There is no default Spice library
225  return wxEmptyString;
226  break;
227 
228  default:
229  wxASSERT_MSG( false, "Missing default value definition for a Spice field" );
230  break;
231  }
232 
233 
234  return wxString( "<unknown>" );
235 }
236 
237 
239 {
240  const wxString delimiters( "{:,; }" );
241  SCH_SHEET_LIST sheetList( g_RootSheet );
242  // Set of reference names, to check for duplications
243  std::set<wxString> refNames;
244 
245  // Prepare list of nets generation (not used here, but...
246  for( unsigned ii = 0; ii < m_masterList->size(); ii++ )
247  m_masterList->GetItem( ii )->m_Flag = 0;
248 
249  m_netMap.clear();
250  m_netMap["GND"] = 0; // 0 is reserved for "GND"
251  int netIdx = 1;
252 
253  m_libraries.clear();
255 
256  UpdateDirectives( aCtl );
257 
258  for( unsigned sheet_idx = 0; sheet_idx < sheetList.size(); sheet_idx++ )
259  {
260  // Process component attributes to find Spice directives
261  for( EDA_ITEM* item = sheetList[sheet_idx].LastDrawList(); item; item = item->Next() )
262  {
263  SCH_COMPONENT* comp = findNextComponentAndCreatePinList( item, &sheetList[sheet_idx] );
264 
265  if( !comp )
266  break;
267 
268  item = comp;
269 
270  SPICE_ITEM spiceItem;
271  spiceItem.m_parent = comp;
272 
273  // Obtain Spice fields
274  SCH_FIELD* fieldLibFile = comp->FindField( GetSpiceFieldName( SF_LIB_FILE ) );
275  SCH_FIELD* fieldSeq = comp->FindField( GetSpiceFieldName( SF_NODE_SEQUENCE ) );
276 
277  spiceItem.m_primitive = GetSpiceField( SF_PRIMITIVE, comp, aCtl )[0];
278  spiceItem.m_model = GetSpiceField( SF_MODEL, comp, aCtl );
279  spiceItem.m_refName = comp->GetRef( &sheetList[sheet_idx] );
280 
281  // Duplicate references will result in simulation errors
282  if( refNames.count( spiceItem.m_refName ) )
283  {
284  DisplayError( NULL, wxT( "There are duplicate components. "
285  "You need to annotate schematics first." ) );
286  return false;
287  }
288 
289  refNames.insert( spiceItem.m_refName );
290 
291  // Check to see if component should be removed from Spice netlist
292  spiceItem.m_enabled = StringToBool( GetSpiceField( SF_ENABLED, comp, aCtl ) );
293 
294  if( fieldLibFile && !fieldLibFile->GetText().IsEmpty() )
295  m_libraries.insert( fieldLibFile->GetText() );
296 
297  wxArrayString pinNames;
298 
299  // Store pin information
300  for( unsigned ii = 0; ii < m_SortedComponentPinList.size(); ii++ )
301  {
303 
304  // NETLIST_EXPORTER marks removed pins by setting them to NULL
305  if( !pin )
306  continue;
307 
308  spiceItem.m_pins.push_back( pin );
309  pinNames.Add( pin->GetPinNumText() );
310 
311  // Create net mapping
312  const wxString& netName = pin->GetNetName();
313  if( m_netMap.count( netName ) == 0 )
314  m_netMap[netName] = netIdx++;
315  }
316 
317  // Check if an alternative pin sequence is available:
318  if( fieldSeq )
319  {
320  // Get the string containing the sequence of nodes:
321  wxString nodeSeqIndexLineStr = fieldSeq->GetText();
322 
323  // Verify field exists and is not empty:
324  if( !nodeSeqIndexLineStr.IsEmpty() )
325  {
326  // Get Alt Pin Name Array From User:
327  wxStringTokenizer tkz( nodeSeqIndexLineStr, delimiters );
328 
329  while( tkz.HasMoreTokens() )
330  {
331  wxString pinIndex = tkz.GetNextToken();
332  int seq;
333 
334  // Find PinName In Standard List assign Standard List Index to Name:
335  seq = pinNames.Index( pinIndex );
336 
337  if( seq != wxNOT_FOUND )
338  spiceItem.m_pinSequence.push_back( seq );
339  }
340  }
341  }
342 
343  m_spiceItems.push_back( spiceItem );
344  }
345  }
346 
347  return true;
348 }
349 
350 
352 {
353  const SCH_SHEET_LIST& sheetList = g_RootSheet;
354 
355  m_directives.clear();
356 
357  for( unsigned i = 0; i < sheetList.size(); i++ )
358  {
359  for( EDA_ITEM* item = sheetList[i].LastDrawList(); item; item = item->Next() )
360  {
361  if( item->Type() != SCH_TEXT_T )
362  continue;
363 
364  wxString text = static_cast<SCH_TEXT*>( item )->GetText();
365 
366  if( text.IsEmpty() )
367  continue;
368 
369  if( text.GetChar( 0 ) == '.' )
370  {
371  wxStringTokenizer tokenizer( text, "\r\n" );
372 
373  while( tokenizer.HasMoreTokens() )
374  {
375  wxString directive( tokenizer.GetNextToken() );
376 
377  if( directive.StartsWith( ".inc" ) )
378  {
379  wxString lib = directive.AfterFirst( ' ' );
380 
381  if( !lib.IsEmpty() )
382  m_libraries.insert( lib );
383  }
384  else
385  {
386  m_directives.push_back( directive );
387  }
388  }
389  }
390  }
391  }
392 }
393 
394 
395 void NETLIST_EXPORTER_PSPICE::writeDirectives( OUTPUTFORMATTER* aFormatter, unsigned aCtl ) const
396 {
397  for( auto& dir : m_directives )
398  {
399  aFormatter->Print( 0, "%s\n", (const char*) dir.c_str() );
400  }
401 }
402 
403 
404 // Entries in the vector below have to follow the order in SPICE_FIELD enum
405 const std::vector<wxString> NETLIST_EXPORTER_PSPICE::m_spiceFields = {
406  "Spice_Primitive",
407  "Spice_Model",
408  "Spice_Netlist_Enabled",
409  "Spice_Node_Sequence",
410  "Spice_Lib_File"
411 };
Class SCH_SHEET_LIST.
Class SCH_FIELD instances are attached to a component and provide a place for the component's value...
Definition: sch_field.h:56
bool Format(OUTPUTFORMATTER *aFormatter, unsigned aCtl)
>
std::vector< NETLIST_OBJECT * > m_pins
Array containing Standard Pin Name
SCH_FIELD * FindField(const wxString &aFieldName, bool aIncludeDefaultFields=true)
Function FindField searches for SCH_FIELD with aFieldName and returns it if found, else NULL.
wxString GetNetName(bool adoptTimestamp=false) const
Function GetNetName.
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.
std::set< wxString > m_libraries
Libraries used by the simulated circuit
This file is part of the common library.
SCH_COMPONENT * m_parent
Schematic component represented by this SPICE_ITEM.
Structure to represent a schematic component in the Spice simulation.
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...
static const wxString & GetSpiceFieldName(SPICE_FIELD aField)
Returns a string used for a particular component field related to Spice simulation.
Class OUTPUTFORMATTER is an important interface (abstract class) used to output 8 bit text in a conve...
Definition: richio.h:327
bool m_enabled
Flag to indicate whether the component should be used in simulation.
SEARCH_STACK * m_paths
Paths to be searched for included Spice libraries
void Clear()
Function Clear erases the record.
std::vector< wxString > m_directives
Spice directives found in the processed schematic sheet
wxString GetPinNumText()
Function GetPinNum returns a pin number in wxString form.
static bool StringToBool(const wxString &aStr)
Convertes typical boolean string values (no/yes, true/false, 1/0) to a boolean value.
wxString m_model
Library model (for semiconductors and subcircuits), component value (for passive components) or volta...
NETLIST_OBJECT_LIST * m_masterList
Field Reference of part, i.e. "IC21".
SPICE_ITEM_LIST m_spiceItems
List of items representing schematic components in the Spice world
static wxString GetSpiceFieldDefVal(SPICE_FIELD aField, SCH_COMPONENT *aComponent, unsigned aCtl)
Retrieves the default value for a given field.
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes...
Definition: macros.h:47
NET_INDEX_MAP m_netMap
Maps circuit nodes to net names
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:54
SCH_FIELD * GetField(int aFieldNdx) const
Function GetField returns a field.
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:130
void UpdateDirectives(unsigned aCtl)
Updates the vector of Spice directives placed in the schematics.
SCH_COMPONENT * findNextComponentAndCreatePinList(EDA_ITEM *aItem, SCH_SHEET_PATH *aSheetPath)
Function findNextComponentAndCreatePinList finds a component from the DrawList and builds its pin lis...
bool ProcessNetlist(unsigned aCtl)
Processes the netlist to create net mapping and a list of SPICE_ITEMs.
wxString GetText(GRAPHIC_PINSHAPE shape)
Definition: pin_shape.cpp:33
static void ReplaceForbiddenChars(wxString &aNetName)
some chars are not accepted in netnames in spice netlists.
virtual void writeDirectives(OUTPUTFORMATTER *aFormatter, unsigned aCtl) const
Saves the Spice directives.
bool WriteNetlist(const wxString &aOutFileName, unsigned aNetlistOptions) override
Function WriteNetlist writes to specified output file.
Definition of the NETLIST_OBJECT class.
Field Value of part, i.e. "3.3K".
NETLIST_OBJECTS m_SortedComponentPinList
no ownership
const wxString GetRef(const SCH_SHEET_PATH *sheet)
Function GetRef returns the reference, for the given sheet path.
void GetPins(std::vector< LIB_PIN * > &aPinsList)
Function GetPins populate a vector with all the pins.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
static wxString GetSpiceField(SPICE_FIELD aField, SCH_COMPONENT *aComponent, unsigned aCtl)
Retrieves either the requested field value or the default value.
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
static const std::vector< wxString > m_spiceFields
wxChar m_primitive
Spice primitive type (
Class FILE_OUTPUTFORMATTER may be used for text file output.
Definition: richio.h:492
wxString FindValidPath(const wxString &aFileName) const
Definition: search_stack.h:71
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
std::vector< int > m_pinSequence
Numeric indices into m_SortedComponentPinList
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:69