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-2019 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 <sch_edit_frame.h>
35 #include <netlist.h>
36 #include <sch_reference_list.h>
37 #include <env_paths.h>
38 
39 #include <wx/tokenzr.h>
40 #include <wx/regex.h>
41 
42 
43 wxString NETLIST_EXPORTER_PSPICE::GetSpiceDevice( const wxString& aComponent ) const
44 {
45  const auto& spiceItems = GetSpiceItems();
46 
47  auto it = std::find_if( spiceItems.begin(), spiceItems.end(), [&]( const SPICE_ITEM& item ) {
48  return item.m_refName == aComponent;
49  } );
50 
51  if( it == spiceItems.end() )
52  return wxEmptyString;
53 
54  // Prefix the device type if plain reference would result in a different device type
55  return it->m_primitive != it->m_refName[0] ?
56  wxString( it->m_primitive + it->m_refName ) : it->m_refName;
57 }
58 
59 
60 bool NETLIST_EXPORTER_PSPICE::WriteNetlist( const wxString& aOutFileName, unsigned aNetlistOptions )
61 {
62  FILE_OUTPUTFORMATTER outputFile( aOutFileName, wxT( "wt" ), '\'' );
63 
64  return Format( &outputFile, aNetlistOptions );
65 }
66 
68 {
69  // some chars are not accepted in netnames in spice netlists, because they are separators
70  // they are replaced an underscore or some other allowed char.
71  // Note: this is a static function
72 
73  aNetName.Replace( "(", "_" );
74  aNetName.Replace( ")", "_" );
75  aNetName.Replace( " ", "_" );
76 }
77 
78 
79 bool NETLIST_EXPORTER_PSPICE::Format( OUTPUTFORMATTER* aFormatter, unsigned aCtl )
80 {
81  // Netlist options
82  const bool useNetcodeAsNetName = false;//aCtl & NET_USE_NETCODES_AS_NETNAMES;
83 
84  // default title
85  m_title = "KiCad schematic";
86 
87  if( !ProcessNetlist( aCtl ) )
88  return false;
89 
90  aFormatter->Print( 0, ".title %s\n", (const char*) m_title.c_str() );
91 
92  // Write .include directives
93  for( const auto& lib : m_libraries )
94  {
95  wxString full_path;
96 
97  if( ( aCtl & NET_ADJUST_INCLUDE_PATHS ) )
98  {
99  // Look for the library in known search locations
100  full_path = ResolveFile( lib, &Pgm().GetLocalEnvVariables(), m_project );
101 
102  if( full_path.IsEmpty() )
103  {
104  DisplayError( NULL, wxString::Format( _( "Could not find library file %s" ), lib ) );
105  full_path = lib;
106  }
107  }
108  else
109  full_path = lib; // just use the unaltered path
110 
111  aFormatter->Print( 0, ".include \"%s\"\n", (const char*) full_path.c_str() );
112  }
113 
114  unsigned int NC_counter = 1;
115 
116  for( const auto& item : m_spiceItems )
117  {
118  if( !item.m_enabled )
119  continue;
120 
121  wxString device = GetSpiceDevice( item.m_refName );
122  aFormatter->Print( 0, "%s ", (const char*) device.c_str() );
123 
124  size_t pspiceNodes = item.m_pinSequence.empty() ? item.m_pins.size() : item.m_pinSequence.size();
125 
126  for( size_t ii = 0; ii < pspiceNodes; ii++ )
127  {
128  // Use the custom order if defined, otherwise use the standard pin order as defined in the compon
129  size_t activePinIndex = item.m_pinSequence.empty() ? ii : item.m_pinSequence[ii];
130  // Valid used Node Indexes are in the set
131  // {0,1,2,...m_item.m_pin.size()-1}
132  if( activePinIndex >= item.m_pins.size() )
133  {
134  wxASSERT_MSG( false, "Used an invalid pin number in node sequence" );
135  continue;
136  }
137 
138  NETLIST_OBJECT* pin = item.m_pins[activePinIndex];
139  assert( pin );
140  wxString netName = pin->GetNetName();
141 
142  if( useNetcodeAsNetName )
143  {
144  assert( m_netMap.count( netName ) );
145  aFormatter->Print( 0, "%d ", m_netMap[netName] );
146  }
147  else
148  {
149  sprintPinNetName( netName , wxT( "N-%.6d" ), pin, useNetcodeAsNetName );
150 
151  // Replace parenthesis with underscore to prevent parse issues with simulators
152  ReplaceForbiddenChars( netName );
153 
154  // unescape net names that contain a escaped sequence ("{slash}"):
155  netName = UnescapeString( netName );
156 
157  // Borrow LTSpice's nomenclature for unconnected nets
158  if( netName.IsEmpty() )
159  netName = wxString::Format( wxT( "NC_%.2u" ), NC_counter++ );
160 
161  aFormatter->Print( 0, "%s ", TO_UTF8( netName ) );
162  }
163  }
164 
165  aFormatter->Print( 0, "%s\n", (const char*) item.m_model.c_str() );
166  }
167 
168  // Print out all directives found in the text fields on the schematics
169  writeDirectives( aFormatter, aCtl );
170 
171  aFormatter->Print( 0, ".end\n" );
172 
173  return true;
174 }
175 
176 
178  SCH_COMPONENT* aComponent, unsigned aCtl )
179 {
180  SCH_FIELD* field = aComponent->FindField( GetSpiceFieldName( aField ) );
181  return field ? field->GetText() : GetSpiceFieldDefVal( aField, aComponent, aCtl );
182 }
183 
184 
186  SCH_COMPONENT* aComponent, unsigned aCtl )
187 {
188  switch( aField )
189  {
190  case SF_PRIMITIVE:
191  {
192  const wxString refName = aComponent->GetField( REFERENCE )->GetText();
193  return refName.GetChar( 0 );
194  break;
195  }
196 
197  case SF_MODEL:
198  {
199  wxChar prim = aComponent->GetField( REFERENCE )->GetText().GetChar( 0 );
200  wxString value = aComponent->GetField( VALUE )->GetText();
201 
202  // Is it a passive component?
203  if( aCtl & NET_ADJUST_PASSIVE_VALS && ( prim == 'C' || prim == 'L' || prim == 'R' ) )
204  {
205  // Regular expression to match common formats used for passive parts description
206  // (e.g. 100k, 2k3, 1 uF)
207  wxRegEx passiveVal( "^([0-9\\. ]+)([fFpPnNuUmMkKgGtT]|M(e|E)(g|G))?([fFhH]|ohm)?([-1-9 ]*)$" );
208 
209  if( passiveVal.Matches( value ) )
210  {
211  wxString prefix( passiveVal.GetMatch( value, 1 ) );
212  wxString unit( passiveVal.GetMatch( value, 2 ) );
213  wxString suffix( passiveVal.GetMatch( value, 6 ) );
214 
215  prefix.Trim(); prefix.Trim( false );
216  unit.Trim(); unit.Trim( false );
217  suffix.Trim(); suffix.Trim( false );
218 
219  // Make 'mega' units comply with the Spice expectations
220  if( unit == "M" )
221  unit = "Meg";
222 
223  value = prefix + unit + suffix;
224  }
225  }
226 
227  return value;
228  break;
229  }
230 
231  case SF_ENABLED:
232  return wxString( "Y" );
233  break;
234 
235  case SF_NODE_SEQUENCE:
236  {
237  wxString nodeSeq;
238  std::vector<LIB_PIN*> pins;
239 
240  auto part = aComponent->GetPartRef().lock();
241  wxCHECK( part, wxString() );
242  part->GetPins( pins );
243 
244  for( auto pin : pins )
245  nodeSeq += pin->GetNumber() + " ";
246 
247  nodeSeq.Trim();
248 
249  return nodeSeq;
250  break;
251  }
252 
253  case SF_LIB_FILE:
254  // There is no default Spice library
255  return wxEmptyString;
256  break;
257 
258  default:
259  wxASSERT_MSG( false, "Missing default value definition for a Spice field" );
260  break;
261  }
262 
263 
264  return wxString( "<unknown>" );
265 }
266 
267 
269 {
270  const wxString delimiters( "{:,; }" );
271  SCH_SHEET_LIST sheetList( g_RootSheet );
272  // Set of reference names, to check for duplications
273  std::set<wxString> refNames;
274 
275  // Prepare list of nets generation (not used here, but...
276  for( unsigned ii = 0; ii < m_masterList->size(); ii++ )
277  m_masterList->GetItem( ii )->m_Flag = 0;
278 
279  m_netMap.clear();
280  m_netMap["GND"] = 0; // 0 is reserved for "GND"
281  int netIdx = 1;
282 
283  m_libraries.clear();
285 
286  UpdateDirectives( aCtl );
287 
288  for( unsigned sheet_idx = 0; sheet_idx < sheetList.size(); sheet_idx++ )
289  {
290  // Process component attributes to find Spice directives
291  for( EDA_ITEM* item = sheetList[sheet_idx].LastDrawList(); item; item = item->Next() )
292  {
293  SCH_COMPONENT* comp = findNextComponentAndCreatePinList( item, &sheetList[sheet_idx] );
294 
295  if( !comp )
296  break;
297 
298  item = comp;
299 
300  SPICE_ITEM spiceItem;
301  spiceItem.m_parent = comp;
302 
303  // Obtain Spice fields
304  SCH_FIELD* fieldLibFile = comp->FindField( GetSpiceFieldName( SF_LIB_FILE ) );
305  SCH_FIELD* fieldSeq = comp->FindField( GetSpiceFieldName( SF_NODE_SEQUENCE ) );
306 
307  spiceItem.m_primitive = GetSpiceField( SF_PRIMITIVE, comp, aCtl )[0];
308  spiceItem.m_model = GetSpiceField( SF_MODEL, comp, aCtl );
309  spiceItem.m_refName = comp->GetRef( &sheetList[sheet_idx] );
310 
311  // Duplicate references will result in simulation errors
312  if( refNames.count( spiceItem.m_refName ) )
313  {
314  DisplayError( NULL, wxT( "There are duplicate components. "
315  "You need to annotate schematics first." ) );
316  return false;
317  }
318 
319  refNames.insert( spiceItem.m_refName );
320 
321  // Check to see if component should be removed from Spice netlist
322  spiceItem.m_enabled = StringToBool( GetSpiceField( SF_ENABLED, comp, aCtl ) );
323 
324  if( fieldLibFile && !fieldLibFile->GetText().IsEmpty() )
325  m_libraries.insert( fieldLibFile->GetText() );
326 
327  wxArrayString pinNames;
328 
329  // Store pin information
330  for( unsigned ii = 0; ii < m_SortedComponentPinList.size(); ii++ )
331  {
333 
334  // NETLIST_EXPORTER marks removed pins by setting them to NULL
335  if( !pin )
336  continue;
337 
338  spiceItem.m_pins.push_back( pin );
339  pinNames.Add( pin->GetPinNumText() );
340 
341  // Create net mapping
342  const wxString& netName = pin->GetNetName();
343  if( m_netMap.count( netName ) == 0 )
344  m_netMap[netName] = netIdx++;
345  }
346 
347  // Check if an alternative pin sequence is available:
348  if( fieldSeq )
349  {
350  // Get the string containing the sequence of nodes:
351  const wxString nodeSeqIndexLineStr = fieldSeq->GetText();
352 
353  // Verify field exists and is not empty:
354  if( !nodeSeqIndexLineStr.IsEmpty() )
355  {
356  // Get Alt Pin Name Array From User:
357  wxStringTokenizer tkz( nodeSeqIndexLineStr, delimiters );
358 
359  while( tkz.HasMoreTokens() )
360  {
361  wxString pinIndex = tkz.GetNextToken();
362  int seq;
363 
364  // Find PinName In Standard List assign Standard List Index to Name:
365  seq = pinNames.Index( pinIndex );
366 
367  if( seq != wxNOT_FOUND )
368  spiceItem.m_pinSequence.push_back( seq );
369  }
370  }
371  }
372 
373  m_spiceItems.push_back( spiceItem );
374  }
375  }
376 
377  return true;
378 }
379 
380 
382 {
383  const SCH_SHEET_LIST& sheetList = g_RootSheet;
384  wxRegEx couplingK( "^[kK][[:digit:]]*[[:space:]]+[[:alnum:]]+[[:space:]]+[[:alnum:]]+",
385  wxRE_ADVANCED );
386 
387  m_directives.clear();
388  bool controlBlock = false;
389 
390  for( unsigned i = 0; i < sheetList.size(); i++ )
391  {
392  for( EDA_ITEM* item = sheetList[i].LastDrawList(); item; item = item->Next() )
393  {
394  if( item->Type() != SCH_TEXT_T )
395  continue;
396 
397  wxString text = static_cast<SCH_TEXT*>( item )->GetText();
398 
399  if( text.IsEmpty() )
400  continue;
401 
402  // Analyze each line of a text field
403  wxStringTokenizer tokenizer( text, "\r\n" );
404 
405  // Flag to follow multiline directives
406  bool directiveStarted = false;
407 
408  while( tokenizer.HasMoreTokens() )
409  {
410  wxString line( tokenizer.GetNextToken() );
411 
412  // Cleanup: remove preceding and trailing white-space characters
413  line.Trim( true ).Trim( false );
414  // Convert to lower-case for parsing purposes only
415  wxString lowercaseline = line;
416  lowercaseline.MakeLower();
417 
418  // 'Include' directive stores the library file name, so it
419  // can be later resolved using a list of paths
420  if( lowercaseline.StartsWith( ".inc" ) )
421  {
422  wxString lib = line.AfterFirst( ' ' );
423 
424  if( lib.IsEmpty() )
425  continue;
426 
427  // Strip quotes if present
428  if( ( lib.StartsWith( "\"" ) && lib.EndsWith( "\"" ) )
429  || ( lib.StartsWith( "'" ) && lib.EndsWith( "'" ) ) )
430  {
431  lib = lib.Mid( 1, lib.Length() - 2 );
432  }
433 
434  m_libraries.insert( lib );
435  }
436 
437  // Store the title to be sure it appears
438  // in the first line of output
439  else if( lowercaseline.StartsWith( ".title " ) )
440  {
441  m_title = line.AfterFirst( ' ' );
442  }
443 
444  // Handle .control .. .endc blocks
445  else if( lowercaseline.IsSameAs( ".control" ) && ( !controlBlock ) )
446  {
447  controlBlock = true;
448  m_directives.push_back( line );
449  }
450  else if( lowercaseline.IsSameAs( ".endc" ) && controlBlock )
451  {
452  controlBlock = false;
453  m_directives.push_back( line );
454  }
455 
456  else if( line.StartsWith( '.' ) // one-line directives
457  || controlBlock // .control .. .endc block
458  || couplingK.Matches( line ) // K## L## L## coupling constant
459  || ( directiveStarted && line.StartsWith( '+' ) ) ) // multiline directives
460  {
461  // Pad the directive to ensure we distinguish between short directives
462  // and the start of a longer directive
463  m_directives.emplace_back( line + " " );
464  }
465 
466  // Mark directive as started or continued in case it is a multi-line one
467  directiveStarted = line.StartsWith( '.' )
468  || ( directiveStarted && line.StartsWith( '+' ) );
469  }
470  }
471  }
472 }
473 
474 
475 void NETLIST_EXPORTER_PSPICE::writeDirectives( OUTPUTFORMATTER* aFormatter, unsigned aCtl ) const
476 {
477  for( auto& dir : m_directives )
478  {
479  aFormatter->Print( 0, "%s\n", (const char*) dir.c_str() );
480  }
481 }
482 
483 
484 // Entries in the vector below have to follow the order in SPICE_FIELD enum
485 const std::vector<wxString> NETLIST_EXPORTER_PSPICE::m_spiceFields = {
486  "Spice_Primitive",
487  "Spice_Model",
488  "Spice_Netlist_Enabled",
489  "Spice_Node_Sequence",
490  "Spice_Lib_File"
491 };
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236
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:52
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)
Search for a SCH_FIELD with aFieldName.
const SPICE_ITEM_LIST & GetSpiceItems() const
Returns list of items representing schematic components in the Spice world.
wxString ResolveFile(const wxString &aFileName, const ENV_VAR_MAP *aEnvVars, const PROJECT *aProject)
Searches the default paths trying to find one with the requested file.
Definition: env_paths.cpp:138
PART_REF & GetPartRef()
UNIQUE_STRINGS m_ReferencesAlreadyFound
Used for "multi parts per package" components, avoids processing a lib component more than once.
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.
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:65
void Clear()
Function Clear erases the record.
std::vector< wxString > m_directives
Spice directives found in the processed schematic sheet
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
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
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:48
wxString m_title
Spice simulation title found in the processed schematic sheet
#define VALUE
NET_INDEX_MAP m_netMap
Maps circuit nodes to net names
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:47
virtual void writeDirectives(OUTPUTFORMATTER *aFormatter, unsigned aCtl) const
Saves the Spice directives.
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.
static void ReplaceForbiddenChars(wxString &aNetName)
some chars are not accepted in netnames in spice netlists.
const wxString GetRef(const SCH_SHEET_PATH *aSheet)
Return the reference for the given sheet path.
PROJECT * m_project
Project object to fetch its settings (e.g. paths)
#define _(s)
const wxString & GetPinNumText() const
Function GetPinNum returns a pin number in wxString form.
bool WriteNetlist(const wxString &aOutFileName, unsigned aNetlistOptions) override
Function WriteNetlist writes to specified output file.
NETLIST_OBJECTS m_SortedComponentPinList
yes ownership, connected items flat list
NETLIST_OBJECT * GetItem(unsigned aIdx) const
Acces to an item in list.
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
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:131
wxString GetNetName(bool adoptTimestamp=false) const
Function GetNetName.
size_t i
Definition: json11.cpp:649
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:73
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
static const std::vector< wxString > m_spiceFields
wxChar m_primitive
Spice primitive type (
wxString GetSpiceDevice(const wxString &aComponent) const
Returns name of Spice device corresponding to a schematic component.
Class FILE_OUTPUTFORMATTER may be used for text file output.
Definition: richio.h:492
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
std::vector< int > m_pinSequence
Numeric indices into m_SortedComponentPinList
virtual const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:124