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