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 <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 }
76 
77 
78 bool NETLIST_EXPORTER_PSPICE::Format( OUTPUTFORMATTER* aFormatter, unsigned aCtl )
79 {
80  // Netlist options
81  const bool useNetcodeAsNetName = false;//aCtl & NET_USE_NETCODES_AS_NETNAMES;
82 
83  // default title
84  m_title = "KiCad schematic";
85 
86  if( !ProcessNetlist( aCtl ) )
87  return false;
88 
89  aFormatter->Print( 0, ".title %s\n", (const char*) m_title.c_str() );
90 
91  // Write .include directives
92  for( const auto& lib : m_libraries )
93  {
94  wxString full_path;
95 
96  if( ( aCtl & NET_ADJUST_INCLUDE_PATHS ) )
97  {
98  // Look for the library in known search locations
99  full_path = ResolveFile( lib, &Pgm().GetLocalEnvVariables(), m_project );
100 
101  if( full_path.IsEmpty() )
102  {
103  DisplayError( NULL, wxString::Format( _( "Could not find library file %s" ), lib ) );
104  full_path = lib;
105  }
106  }
107  else
108  full_path = lib; // just use the unaltered path
109 
110  aFormatter->Print( 0, ".include \"%s\"\n", (const char*) full_path.c_str() );
111  }
112 
113  unsigned int NC_counter = 1;
114 
115  for( const auto& item : m_spiceItems )
116  {
117  if( !item.m_enabled )
118  continue;
119 
120  wxString device = GetSpiceDevice( item.m_refName );
121  aFormatter->Print( 0, "%s ", (const char*) device.c_str() );
122 
123  size_t pspiceNodes = item.m_pinSequence.empty() ? item.m_pins.size() : item.m_pinSequence.size();
124 
125  for( size_t ii = 0; ii < pspiceNodes; ii++ )
126  {
127  // Use the custom order if defined, otherwise use the standard pin order as defined in the compon
128  size_t activePinIndex = item.m_pinSequence.empty() ? ii : item.m_pinSequence[ii];
129  // Valid used Node Indexes are in the set
130  // {0,1,2,...m_item.m_pin.size()-1}
131  if( activePinIndex >= item.m_pins.size() )
132  {
133  wxASSERT_MSG( false, "Used an invalid pin number in node sequence" );
134  continue;
135  }
136 
137  NETLIST_OBJECT* pin = item.m_pins[activePinIndex];
138  assert( pin );
139  wxString netName = pin->GetNetName();
140 
141  if( useNetcodeAsNetName )
142  {
143  assert( m_netMap.count( netName ) );
144  aFormatter->Print( 0, "%d ", m_netMap[netName] );
145  }
146  else
147  {
148  sprintPinNetName( netName , wxT( "N-%.6d" ), pin, useNetcodeAsNetName );
149 
150  // Replace parenthesis with underscore to prevent parse issues with simulators
151  ReplaceForbiddenChars( netName );
152 
153  // Borrow LTSpice's nomenclature for unconnected nets
154  if( netName.IsEmpty() )
155  netName = wxString::Format( wxT( "NC_%.2u" ), NC_counter++ );
156 
157  aFormatter->Print( 0, "%s ", TO_UTF8( netName ) );
158  }
159  }
160 
161  aFormatter->Print( 0, "%s\n", (const char*) item.m_model.c_str() );
162  }
163 
164  // Print out all directives found in the text fields on the schematics
165  writeDirectives( aFormatter, aCtl );
166 
167  aFormatter->Print( 0, ".end\n" );
168 
169  return true;
170 }
171 
172 
174  SCH_COMPONENT* aComponent, unsigned aCtl )
175 {
176  SCH_FIELD* field = aComponent->FindField( GetSpiceFieldName( aField ) );
177  return field ? field->GetText() : GetSpiceFieldDefVal( aField, aComponent, aCtl );
178 }
179 
180 
182  SCH_COMPONENT* aComponent, unsigned aCtl )
183 {
184  switch( aField )
185  {
186  case SF_PRIMITIVE:
187  {
188  const wxString& refName = aComponent->GetField( REFERENCE )->GetText();
189  return refName.GetChar( 0 );
190  break;
191  }
192 
193  case SF_MODEL:
194  {
195  wxChar prim = aComponent->GetField( REFERENCE )->GetText().GetChar( 0 );
196  wxString value = aComponent->GetField( VALUE )->GetText();
197 
198  // Is it a passive component?
199  if( aCtl & NET_ADJUST_PASSIVE_VALS && ( prim == 'C' || prim == 'L' || prim == 'R' ) )
200  {
201  // Regular expression to match common formats used for passive parts description
202  // (e.g. 100k, 2k3, 1 uF)
203  wxRegEx passiveVal( "^([0-9\\. ]+)([fFpPnNuUmMkKgGtT]|M(e|E)(g|G))?([fFhH]|ohm)?([-1-9 ]*)$" );
204 
205  if( passiveVal.Matches( value ) )
206  {
207  wxString prefix( passiveVal.GetMatch( value, 1 ) );
208  wxString unit( passiveVal.GetMatch( value, 2 ) );
209  wxString suffix( passiveVal.GetMatch( value, 6 ) );
210 
211  prefix.Trim(); prefix.Trim( false );
212  unit.Trim(); unit.Trim( false );
213  suffix.Trim(); suffix.Trim( false );
214 
215  // Make 'mega' units comply with the Spice expectations
216  if( unit == "M" )
217  unit = "Meg";
218 
219  value = prefix + unit + suffix;
220  }
221  }
222 
223  return value;
224  break;
225  }
226 
227  case SF_ENABLED:
228  return wxString( "Y" );
229  break;
230 
231  case SF_NODE_SEQUENCE:
232  {
233  wxString nodeSeq;
234  std::vector<LIB_PIN*> pins;
235 
236  auto part = aComponent->GetPartRef().lock();
237  wxCHECK( part, wxString() );
238  part->GetPins( pins );
239 
240  for( auto pin : pins )
241  nodeSeq += pin->GetNumber() + " ";
242 
243  nodeSeq.Trim();
244 
245  return nodeSeq;
246  break;
247  }
248 
249  case SF_LIB_FILE:
250  // There is no default Spice library
251  return wxEmptyString;
252  break;
253 
254  default:
255  wxASSERT_MSG( false, "Missing default value definition for a Spice field" );
256  break;
257  }
258 
259 
260  return wxString( "<unknown>" );
261 }
262 
263 
265 {
266  const wxString delimiters( "{:,; }" );
267  SCH_SHEET_LIST sheetList( g_RootSheet );
268  // Set of reference names, to check for duplications
269  std::set<wxString> refNames;
270 
271  // Prepare list of nets generation (not used here, but...
272  for( unsigned ii = 0; ii < m_masterList->size(); ii++ )
273  m_masterList->GetItem( ii )->m_Flag = 0;
274 
275  m_netMap.clear();
276  m_netMap["GND"] = 0; // 0 is reserved for "GND"
277  int netIdx = 1;
278 
279  m_libraries.clear();
281 
282  UpdateDirectives( aCtl );
283 
284  for( unsigned sheet_idx = 0; sheet_idx < sheetList.size(); sheet_idx++ )
285  {
286  // Process component attributes to find Spice directives
287  for( EDA_ITEM* item = sheetList[sheet_idx].LastDrawList(); item; item = item->Next() )
288  {
289  SCH_COMPONENT* comp = findNextComponentAndCreatePinList( item, &sheetList[sheet_idx] );
290 
291  if( !comp )
292  break;
293 
294  item = comp;
295 
296  SPICE_ITEM spiceItem;
297  spiceItem.m_parent = comp;
298 
299  // Obtain Spice fields
300  SCH_FIELD* fieldLibFile = comp->FindField( GetSpiceFieldName( SF_LIB_FILE ) );
301  SCH_FIELD* fieldSeq = comp->FindField( GetSpiceFieldName( SF_NODE_SEQUENCE ) );
302 
303  spiceItem.m_primitive = GetSpiceField( SF_PRIMITIVE, comp, aCtl )[0];
304  spiceItem.m_model = GetSpiceField( SF_MODEL, comp, aCtl );
305  spiceItem.m_refName = comp->GetRef( &sheetList[sheet_idx] );
306 
307  // Duplicate references will result in simulation errors
308  if( refNames.count( spiceItem.m_refName ) )
309  {
310  DisplayError( NULL, wxT( "There are duplicate components. "
311  "You need to annotate schematics first." ) );
312  return false;
313  }
314 
315  refNames.insert( spiceItem.m_refName );
316 
317  // Check to see if component should be removed from Spice netlist
318  spiceItem.m_enabled = StringToBool( GetSpiceField( SF_ENABLED, comp, aCtl ) );
319 
320  if( fieldLibFile && !fieldLibFile->GetText().IsEmpty() )
321  m_libraries.insert( fieldLibFile->GetText() );
322 
323  wxArrayString pinNames;
324 
325  // Store pin information
326  for( unsigned ii = 0; ii < m_SortedComponentPinList.size(); ii++ )
327  {
329 
330  // NETLIST_EXPORTER marks removed pins by setting them to NULL
331  if( !pin )
332  continue;
333 
334  spiceItem.m_pins.push_back( pin );
335  pinNames.Add( pin->GetPinNumText() );
336 
337  // Create net mapping
338  const wxString& netName = pin->GetNetName();
339  if( m_netMap.count( netName ) == 0 )
340  m_netMap[netName] = netIdx++;
341  }
342 
343  // Check if an alternative pin sequence is available:
344  if( fieldSeq )
345  {
346  // Get the string containing the sequence of nodes:
347  const wxString& nodeSeqIndexLineStr = fieldSeq->GetText();
348 
349  // Verify field exists and is not empty:
350  if( !nodeSeqIndexLineStr.IsEmpty() )
351  {
352  // Get Alt Pin Name Array From User:
353  wxStringTokenizer tkz( nodeSeqIndexLineStr, delimiters );
354 
355  while( tkz.HasMoreTokens() )
356  {
357  wxString pinIndex = tkz.GetNextToken();
358  int seq;
359 
360  // Find PinName In Standard List assign Standard List Index to Name:
361  seq = pinNames.Index( pinIndex );
362 
363  if( seq != wxNOT_FOUND )
364  spiceItem.m_pinSequence.push_back( seq );
365  }
366  }
367  }
368 
369  m_spiceItems.push_back( spiceItem );
370  }
371  }
372 
373  return true;
374 }
375 
376 
378 {
379  const SCH_SHEET_LIST& sheetList = g_RootSheet;
380 
381  m_directives.clear();
382 
383  for( unsigned i = 0; i < sheetList.size(); i++ )
384  {
385  for( EDA_ITEM* item = sheetList[i].LastDrawList(); item; item = item->Next() )
386  {
387  if( item->Type() != SCH_TEXT_T )
388  continue;
389 
390  wxString text = static_cast<SCH_TEXT*>( item )->GetText();
391 
392  if( text.IsEmpty() )
393  continue;
394 
395  if( text.GetChar( 0 ) == '.' )
396  {
397  wxStringTokenizer tokenizer( text, "\r\n" );
398 
399  while( tokenizer.HasMoreTokens() )
400  {
401  wxString directive( tokenizer.GetNextToken() );
402 
403  if( directive.StartsWith( ".inc" ) )
404  {
405  wxString lib = directive.AfterFirst( ' ' );
406 
407  if( !lib.IsEmpty() )
408  m_libraries.insert( lib );
409  }
410  else if( directive.StartsWith( ".title " ) )
411  {
412  m_title = directive.AfterFirst( ' ' );
413  }
414  else
415  {
416  m_directives.push_back( directive );
417  }
418  }
419  }
420  }
421  }
422 }
423 
424 
425 void NETLIST_EXPORTER_PSPICE::writeDirectives( OUTPUTFORMATTER* aFormatter, unsigned aCtl ) const
426 {
427  for( auto& dir : m_directives )
428  {
429  aFormatter->Print( 0, "%s\n", (const char*) dir.c_str() );
430  }
431 }
432 
433 
434 // Entries in the vector below have to follow the order in SPICE_FIELD enum
435 const std::vector<wxString> NETLIST_EXPORTER_PSPICE::m_spiceFields = {
436  "Spice_Primitive",
437  "Spice_Model",
438  "Spice_Netlist_Enabled",
439  "Spice_Node_Sequence",
440  "Spice_Lib_File"
441 };
Class SCH_SHEET_LIST.
Class SCH_FIELD instances are attached to a component and provide a place for the component&#39;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)
Search for a SCH_FIELD with aFieldName.
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
wxString GetNetName(bool adoptTimestamp=false) const
Function GetNetName.
PART_REF & GetPartRef()
const wxString & GetPinNumText() const
Function GetPinNum returns a pin number in wxString form.
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.
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:66
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
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
wxString m_title
Spice simulation title found in the processed schematic sheet
NET_INDEX_MAP m_netMap
Maps circuit nodes to net names
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:55
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:128
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.
const SPICE_ITEM_LIST & GetSpiceItems() const
Returns list of items representing schematic components in the Spice world.
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.
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)
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.
NETLIST_OBJECTS m_SortedComponentPinList
yes ownership, connected items flat 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
size_t i
Definition: json11.cpp:597
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:162
wxString GetSpiceDevice(const wxString &aComponent) const
Returns name of Spice device corresponding to a schematic component.
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
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
#define VALUE
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:185