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 <[email protected]>
6  * Copyright (C) 1992-2021 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 <build_version.h>
28 #include <confirm.h>
29 
30 #include <map>
31 #include <search_stack.h>
32 
33 #include <connection_graph.h>
34 #include <string_utils.h>
35 #include <sch_edit_frame.h>
36 #include <sch_reference_list.h>
37 #include <env_paths.h>
38 #include <pgm_base.h>
39 #include <common.h>
40 
41 #include <wx/tokenzr.h>
42 #include <wx/regex.h>
43 
44 
45 wxString NETLIST_EXPORTER_PSPICE::GetSpiceDevice( const wxString& aSymbol ) const
46 {
47  const std::list<SPICE_ITEM>& spiceItems = GetSpiceItems();
48 
49  auto it = std::find_if( spiceItems.begin(), spiceItems.end(),
50  [&]( const SPICE_ITEM& item )
51  {
52  return item.m_refName == aSymbol;
53  } );
54 
55  if( it == spiceItems.end() )
56  return wxEmptyString;
57 
58  // Prefix the device type if plain reference would result in a different device type
59  return it->m_primitive != it->m_refName[0] ? wxString( it->m_primitive + it->m_refName )
60  : it->m_refName;
61 }
62 
63 
64 bool NETLIST_EXPORTER_PSPICE::WriteNetlist( const wxString& aOutFileName, unsigned aNetlistOptions )
65 {
66  try
67  {
68  FILE_OUTPUTFORMATTER outputFile( aOutFileName, wxT( "wt" ), '\'' );
69 
70 
71  return Format( &outputFile, aNetlistOptions );
72  }
73  catch( IO_ERROR& )
74  {
75  wxString msg;
76  msg.Printf( _( "Failed to create file '%s'." ), aOutFileName );
77  DisplayError( nullptr, msg );
78  return false;
79  }
80 }
81 
82 
84 {
85  // some chars are not accepted in netnames in spice netlists, because they are separators
86  // they are replaced an underscore or some other allowed char.
87  // Note: this is a static function
88 
89  aNetName.Replace( "(", "_" );
90  aNetName.Replace( ")", "_" );
91  aNetName.Replace( " ", "_" );
92 }
93 
94 
95 bool NETLIST_EXPORTER_PSPICE::Format( OUTPUTFORMATTER* aFormatter, unsigned aCtl )
96 {
97  // Netlist options
98  const bool useNetcodeAsNetName = false;//aCtl & NET_USE_NETCODES_AS_NETNAMES;
99 
100  // default title
101  m_title = "KiCad schematic";
102 
103  if( !ProcessNetlist( aCtl ) )
104  return false;
105 
106  aFormatter->Print( 0, ".title %s\n", TO_UTF8( m_title ) );
107 
108  // Write .include directives
109  for( const wxString& curr_lib : m_libraries )
110  {
111  // First, expand env vars, if any
112  wxString libname = ExpandEnvVarSubstitutions( curr_lib, &m_schematic->Prj() );
113  wxString full_path;
114 
115  if( ( aCtl & NET_ADJUST_INCLUDE_PATHS ) )
116  {
117  // Look for the library in known search locations
118  full_path = ResolveFile( libname, &Pgm().GetLocalEnvVariables(), &m_schematic->Prj() );
119 
120  if( full_path.IsEmpty() )
121  {
122  DisplayError( nullptr, wxString::Format( _( "Could not find library file %s." ),
123  libname ) );
124  full_path = libname;
125  }
126  }
127  else
128  {
129  full_path = libname; // just use the unaltered path
130  }
131 
132  aFormatter->Print( 0, ".include \"%s\"\n", TO_UTF8( full_path ) );
133  }
134 
135  unsigned int NC_counter = 1;
136 
137  for( const SPICE_ITEM& item : m_spiceItems )
138  {
139  if( !item.m_enabled )
140  continue;
141 
142  wxString device = GetSpiceDevice( item.m_refName );
143  aFormatter->Print( 0, "%s ", TO_UTF8( device ) );
144 
145  size_t pspiceNodes =
146  item.m_pinSequence.empty() ? item.m_pins.size() : item.m_pinSequence.size();
147 
148  for( size_t ii = 0; ii < pspiceNodes; ii++ )
149  {
150  // Use the custom order if defined, otherwise use the standard pin order as defined
151  // in the symbol.
152  size_t activePinIndex = item.m_pinSequence.empty() ? ii : item.m_pinSequence[ii];
153 
154  // Valid used Node Indexes are in the set
155  // {0,1,2,...m_item.m_pin.size()-1}
156  if( activePinIndex >= item.m_pins.size() )
157  {
158  wxASSERT_MSG( false, "Used an invalid pin number in node sequence" );
159  continue;
160  }
161 
162  wxString netName = item.m_pins[activePinIndex];
163 
164  wxASSERT( m_netMap.count( netName ) );
165 
166  if( useNetcodeAsNetName )
167  {
168  aFormatter->Print( 0, "%d ", m_netMap[netName] );
169  }
170  else
171  {
172  // Replace parenthesis with underscore to prevent parse issues with simulators
173  ReplaceForbiddenChars( netName );
174 
175  // unescape net names that contain a escaped sequence ("{slash}"):
176  netName = UnescapeString( netName );
177 
178  // Borrow LTSpice's nomenclature for unconnected nets
179  if( netName.IsEmpty() )
180  netName = wxString::Format( wxT( "NC_%.2u" ), NC_counter++ );
181 
182  aFormatter->Print( 0, "%s ", TO_UTF8( netName ) );
183  }
184  }
185 
186  aFormatter->Print( 0, "%s\n", TO_UTF8( item.m_model ) );
187  }
188 
189  // Print out all directives found in the text fields on the schematics
190  writeDirectives( aFormatter, aCtl );
191 
192  aFormatter->Print( 0, ".end\n" );
193 
194  return true;
195 }
196 
197 
199  unsigned aCtl )
200 {
201  SCH_FIELD* field = aSymbol->FindField( GetSpiceFieldName( aField ) );
202  return field ? field->GetShownText() : GetSpiceFieldDefVal( aField, aSymbol, aCtl );
203 }
204 
205 
207  unsigned aCtl )
208 {
209  switch( aField )
210  {
211  case SF_PRIMITIVE:
212  {
213  const wxString refName = aSymbol->GetField( REFERENCE_FIELD )->GetShownText();
214  return refName.GetChar( 0 );
215  }
216 
217  case SF_MODEL:
218  {
219  wxChar prim = aSymbol->GetField( REFERENCE_FIELD )->GetShownText().GetChar( 0 );
220  wxString value = aSymbol->GetField( VALUE_FIELD )->GetShownText();
221 
222  // Is it a passive component?
223  if( ( aCtl & NET_ADJUST_PASSIVE_VALS ) && ( prim == 'C' || prim == 'L' || prim == 'R' ) )
224  {
225  // Regular expression to match common formats used for passive parts description
226  // (e.g. 100k, 2k3, 1 uF)
227  wxRegEx passiveVal(
228  wxT( "^([0-9\\. ]+)([fFpPnNuUmMkKgGtTμµ𝛍𝜇𝝁 ]|M(e|E)(g|G))?([fFhHΩΩ𝛀𝛺𝝮]|ohm)?([-1-9 ]*)$" ) );
229 
230  if( passiveVal.Matches( value ) )
231  {
232  wxString prefix( passiveVal.GetMatch( value, 1 ) );
233  wxString unit( passiveVal.GetMatch( value, 2 ) );
234  wxString suffix( passiveVal.GetMatch( value, 6 ) );
235 
236  prefix.Trim(); prefix.Trim( false );
237  unit.Trim(); unit.Trim( false );
238  suffix.Trim(); suffix.Trim( false );
239 
240  // Make 'mega' units comply with the Spice expectations
241  if( unit == "M" )
242  unit = "Meg";
243 
244  value = prefix + unit + suffix;
245  }
246  }
247 
248  return value;
249  }
250 
251  case SF_ENABLED:
252  return wxString( "Y" );
253 
254  case SF_NODE_SEQUENCE:
255  {
256  wxString nodeSeq;
257  std::vector<LIB_PIN*> pins;
258 
259  wxCHECK( aSymbol->GetLibSymbolRef(), wxString() );
260  aSymbol->GetLibSymbolRef()->GetPins( pins );
261 
262  for( LIB_PIN* pin : pins )
263  nodeSeq += pin->GetNumber() + " ";
264 
265  nodeSeq.Trim();
266 
267  return nodeSeq;
268  }
269 
270  case SF_LIB_FILE:
271  // There is no default Spice library
272  return wxEmptyString;
273 
274  default:
275  wxASSERT_MSG( false, "Missing default value definition for a Spice field." );
276  return wxString( "<unknown>" );
277  }
278 }
279 
280 
282 {
283  const wxString delimiters( "{:,; }" );
284  SCH_SHEET_LIST sheetList = m_schematic->GetSheets();
285  std::set<wxString> refNames; // Set of reference names, to check for duplication
286 
287  m_netMap.clear();
288  m_netMap["GND"] = 0; // 0 is reserved for "GND"
289  int netIdx = 1;
290 
291  m_libraries.clear();
293  m_libParts.clear();
294 
295  UpdateDirectives( aCtl );
296 
297  for( unsigned sheet_idx = 0; sheet_idx < sheetList.size(); sheet_idx++ )
298  {
299  SCH_SHEET_PATH sheet = sheetList[sheet_idx];
300 
301  // Process symbol attributes to find Spice directives
302  for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
303  {
304  SCH_SYMBOL* symbol = findNextSymbol( item, &sheet );
305 
306  if( !symbol )
307  continue;
308 
309  CreatePinList( symbol, &sheet, true );
310  SPICE_ITEM spiceItem;
311  spiceItem.m_parent = symbol;
312 
313  // Obtain Spice fields
314  SCH_FIELD* fieldLibFile = symbol->FindField( GetSpiceFieldName( SF_LIB_FILE ) );
315  SCH_FIELD* fieldSeq = symbol->FindField( GetSpiceFieldName( SF_NODE_SEQUENCE ) );
316 
317  spiceItem.m_primitive = GetSpiceField( SF_PRIMITIVE, symbol, aCtl )[0];
318  spiceItem.m_model = GetSpiceField( SF_MODEL, symbol, aCtl );
319  spiceItem.m_refName = symbol->GetRef( &sheet );
320 
321  // Duplicate references will result in simulation errors
322  if( refNames.count( spiceItem.m_refName ) )
323  {
324  DisplayError( nullptr, _( "Multiple symbols have the same reference designator.\n"
325  "Annotation must be corrected before simulating." ) );
326  return false;
327  }
328 
329  refNames.insert( spiceItem.m_refName );
330 
331  // Check to see if symbol should be removed from Spice netlist
332  spiceItem.m_enabled = StringToBool( GetSpiceField( SF_ENABLED, symbol, aCtl ) );
333 
334  if( fieldLibFile && !fieldLibFile->GetShownText().IsEmpty() )
335  m_libraries.insert( fieldLibFile->GetShownText() );
336 
337  wxArrayString pinNames;
338 
339  // Store pin information
340  for( const PIN_INFO& pin : m_sortedSymbolPinList )
341  {
342  // Create net mapping
343  spiceItem.m_pins.push_back( pin.netName );
344  pinNames.Add( pin.num );
345 
346  if( m_netMap.count( pin.netName ) == 0 )
347  m_netMap[pin.netName] = netIdx++;
348  }
349 
350  // Check if an alternative pin sequence is available:
351  if( fieldSeq )
352  {
353  // Get the string containing the sequence of nodes:
354  const wxString& nodeSeqIndexLineStr = fieldSeq->GetShownText();
355 
356  // Verify field exists and is not empty:
357  if( !nodeSeqIndexLineStr.IsEmpty() )
358  {
359  // Get Alt Pin Name Array From User:
360  wxStringTokenizer tkz( nodeSeqIndexLineStr, delimiters );
361 
362  while( tkz.HasMoreTokens() )
363  {
364  wxString pinIndex = tkz.GetNextToken();
365  int seq;
366 
367  // Find PinName In Standard List assign Standard List Index to Name:
368  seq = pinNames.Index( pinIndex );
369 
370  if( seq != wxNOT_FOUND )
371  spiceItem.m_pinSequence.push_back( seq );
372  }
373  }
374  }
375 
376  m_spiceItems.push_back( spiceItem );
377  }
378  }
379 
380  return true;
381 }
382 
383 
385 {
386  const SCH_SHEET_LIST& sheetList = m_schematic->GetSheets();
387  wxRegEx couplingK( "^[kK][[:digit:]]*[[:space:]]+[[:alnum:]]+[[:space:]]+[[:alnum:]]+",
388  wxRE_ADVANCED );
389 
390  m_directives.clear();
391  bool controlBlock = false;
392  bool circuitBlock = false;
393 
394  for( unsigned i = 0; i < sheetList.size(); i++ )
395  {
396  for( SCH_ITEM* item : sheetList[i].LastScreen()->Items().OfType( SCH_TEXT_T ) )
397  {
398  wxString text = static_cast<SCH_TEXT*>( item )->GetShownText();
399 
400  if( text.IsEmpty() )
401  continue;
402 
403  // Analyze each line of a text field
404  wxStringTokenizer tokenizer( text, "\r\n" );
405 
406  // Flag to follow multiline directives
407  bool directiveStarted = false;
408 
409  while( tokenizer.HasMoreTokens() )
410  {
411  wxString line( tokenizer.GetNextToken() );
412 
413  // Cleanup: remove preceding and trailing white-space characters
414  line.Trim( true ).Trim( false );
415  // Convert to lower-case for parsing purposes only
416  wxString lowercaseline = line;
417  lowercaseline.MakeLower();
418 
419  // 'Include' directive stores the library file name, so it
420  // can be later resolved using a list of paths
421  if( lowercaseline.StartsWith( ".inc" ) )
422  {
423  wxString lib = line.AfterFirst( ' ' );
424 
425  if( lib.IsEmpty() )
426  continue;
427 
428  // Strip quotes if present
429  if( ( lib.StartsWith( "\"" ) && lib.EndsWith( "\"" ) )
430  || ( lib.StartsWith( "'" ) && lib.EndsWith( "'" ) ) )
431  {
432  lib = lib.Mid( 1, lib.Length() - 2 );
433  }
434 
435  m_libraries.insert( lib );
436  }
437 
438  // Store the title to be sure it appears
439  // in the first line of output
440  else if( lowercaseline.StartsWith( ".title " ) )
441  {
442  m_title = line.AfterFirst( ' ' );
443  }
444 
445  else if( line.StartsWith( '.' ) // one-line directives
446  || controlBlock // .control .. .endc block
447  || circuitBlock // .subckt .. .ends block
448  || couplingK.Matches( line ) // K## L## L## coupling constant
449  || ( directiveStarted && line.StartsWith( '+' ) ) ) // multiline directives
450  {
451  m_directives.push_back( line );
452  }
453 
454  // Handle .control .. .endc blocks
455  if( lowercaseline.IsSameAs( ".control" ) && ( !controlBlock ) )
456  controlBlock = true;
457 
458  if( lowercaseline.IsSameAs( ".endc" ) && controlBlock )
459  controlBlock = false;
460 
461  // Handle .subckt .. .ends blocks
462  if( lowercaseline.StartsWith( ".subckt" ) && ( !circuitBlock ) )
463  circuitBlock = true;
464 
465  if( lowercaseline.IsSameAs( ".ends" ) && circuitBlock )
466  circuitBlock = false;
467 
468  // Mark directive as started or continued in case it is a multi-line one
469  directiveStarted = line.StartsWith( '.' )
470  || ( directiveStarted && line.StartsWith( '+' ) );
471  }
472  }
473  }
474 }
475 
476 
477 void NETLIST_EXPORTER_PSPICE::writeDirectives( OUTPUTFORMATTER* aFormatter, unsigned aCtl ) const
478 {
479  for( const wxString& dir : m_directives )
480  aFormatter->Print( 0, "%s\n", TO_UTF8( dir ) );
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 };
Field Reference of part, i.e. "IC21".
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:279
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:230
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
bool Format(OUTPUTFORMATTER *aFormatter, unsigned aCtl)
wxString ResolveFile(const wxString &aFileName, const ENV_VAR_MAP *aEnvVars, const PROJECT *aProject)
Search the default paths trying to find one with the requested file.
Definition: env_paths.cpp:162
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:705
std::set< wxString > m_libraries
Spice libraries used by the simulated circuit.
std::vector< PIN_INFO > m_sortedSymbolPinList
Used to temporarily store and filter the list of pins of a schematic symbol when generating schematic...
This file is part of the common library.
std::list< SPICE_ITEM > m_spiceItems
Items representing schematic symbols in Spice world.
Structure to represent a schematic symbol in the Spice simulation.
std::vector< wxString > m_pins
Array containing Standard Pin Name.
static const wxString & GetSpiceFieldName(SPICE_FIELD aField)
Return a string used for a particular component field related to Spice simulation.
An interface used to output 8 bit text in a convenient way.
Definition: richio.h:309
bool m_enabled
Whether the symbol should be used in simulation.
void Clear()
Erase the record.
std::vector< wxString > m_directives
Spice directives found in the schematic sheet.
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
Definition: sch_symbol.cpp:464
const wxString ExpandEnvVarSubstitutions(const wxString &aString, PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition: common.cpp:267
static bool StringToBool(const wxString &aStr)
Convert typical boolean string values (no/yes, true/false, 1/0) to a boolean value.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
SCH_SYMBOL * m_parent
Schematic symbol represented by this SPICE_ITEM.
wxString m_model
Library model (for semiconductors and subcircuits), component value (for passive components) or volta...
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: sch_field.cpp:105
std::unique_ptr< LIB_SYMBOL > & GetLibSymbolRef()
Definition: sch_symbol.h:165
SCH_SYMBOL * findNextSymbol(EDA_ITEM *aItem, SCH_SHEET_PATH *aSheetPath)
Check if the given symbol should be processed for netlisting.
SCHEMATIC_IFACE * m_schematic
The schematic we're generating a netlist for.
virtual PROJECT & Prj() const =0
UNIQUE_STRINGS m_referencesAlreadyFound
Used for "multiple symbols per package" symbols to avoid processing a lib symbol more than once.
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
wxString m_title
Spice simulation title found in the schematic sheet.
std::map< wxString, int > m_netMap
Map spice nodes to net codes.
Field Value of part, i.e. "3.3K".
const std::list< SPICE_ITEM > & GetSpiceItems() const
Return list of items representing schematic components in the Spice world.
static wxString GetSpiceFieldDefVal(SPICE_FIELD aField, SCH_SYMBOL *aSymbol, unsigned aCtl)
Retrieve the default value for a given field.
virtual void writeDirectives(OUTPUTFORMATTER *aFormatter, unsigned aCtl) const
Save the Spice directives.
void CreatePinList(SCH_SYMBOL *aSymbol, SCH_SHEET_PATH *aSheetPath, bool aKeepUnconnectedPins)
Find a symbol from the DrawList and builds its pin list in m_sortedSymbolPinList.
void UpdateDirectives(unsigned aCtl)
Update the vector of Spice directives placed in the schematics.
wxString GetSpiceDevice(const wxString &aSymbol) const
Return name of Spice device corresponding to a schematic symbol.
bool ProcessNetlist(unsigned aCtl)
Process the netlist to create net mapping and a list of SPICE_ITEMs.
#define _(s)
static void ReplaceForbiddenChars(wxString &aNetName)
Replace illegal spice net name characters with an underscore.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
SCH_FIELD * FindField(const wxString &aFieldName, bool aIncludeDefaultFields=true)
Search for a SCH_FIELD with aFieldName.
Definition: sch_symbol.cpp:773
wxString UnescapeString(const wxString &aSource)
static wxString GetSpiceField(SPICE_FIELD aField, SCH_SYMBOL *aSymbol, unsigned aCtl)
Retrieve either the requested field value or the default value.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
bool WriteNetlist(const wxString &aOutFileName, unsigned aNetlistOptions) override
Write to specified output file.
see class PGM_BASE
Schematic symbol object.
Definition: sch_symbol.h:78
SCH_SCREEN * LastScreen()
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
Definition: sch_screen.h:110
The common library.
static const std::vector< wxString > m_spiceFields
wxChar m_primitive
Spice primitive type (.
Used for text file output.
Definition: richio.h:456
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426
std::vector< int > m_pinSequence
Numeric indices into m_SortedSymbolPinList.
std::set< LIB_SYMBOL *, LIB_SYMBOL_LESS_THAN > m_libParts
unique library symbols used. LIB_SYMBOL items are sorted by names
virtual SCH_SHEET_LIST GetSheets() const =0
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:182