KiCad PCB EDA Suite
Loading...
Searching...
No Matches
netlist_exporter_spice.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 The 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
26#include <sim/kibis/kibis.h>
31#include <common.h>
32#include <confirm.h>
33#include <pgm_base.h>
34#include <env_paths.h>
35#include <richio.h>
38#include <sch_screen.h>
39#include <sch_textbox.h>
40#include <string_utils.h>
41#include <algorithm>
42#include <ki_exception.h>
43
45#include <fmt/core.h>
46#include <paths.h>
47#include <wx/dir.h>
48#include <wx/log.h>
49#include <locale_io.h>
50#include "markup_parser.h"
51
52
53std::string NAME_GENERATOR::Generate( const std::string& aProposedName )
54{
55 std::string name = aProposedName;
56 int ii = 1;
57
58 while( m_names.contains( name ) )
59 name = fmt::format( "{}#{}", aProposedName, ii++ );
60
61 return name;
62}
63
64
66 NETLIST_EXPORTER_BASE( aSchematic ),
67 m_libMgr( &aSchematic->Project() )
68{
69 std::vector<EMBEDDED_FILES*> embeddedFilesStack;
70 embeddedFilesStack.push_back( aSchematic->GetEmbeddedFiles() );
71 m_libMgr.SetFilesStack( std::move( embeddedFilesStack ) );
72}
73
74
75bool NETLIST_EXPORTER_SPICE::WriteNetlist( const wxString& aOutFileName, unsigned aNetlistOptions,
76 REPORTER& aReporter )
77{
78 FILE_OUTPUTFORMATTER formatter( aOutFileName, wxT( "wt" ), '\'' );
79 return DoWriteNetlist( wxEmptyString, aNetlistOptions, formatter, aReporter );
80}
81
82
83bool NETLIST_EXPORTER_SPICE::DoWriteNetlist( const wxString& aSimCommand, unsigned aSimOptions,
84 OUTPUTFORMATTER& aFormatter, REPORTER& aReporter )
85{
87
88 // Cleanup list to avoid duplicate if the netlist exporter is run more than once.
89 m_rawIncludes.clear();
90
91 bool result = ReadSchematicAndLibraries( aSimOptions, aReporter );
92
93 WriteHead( aFormatter, aSimOptions );
94
95 writeIncludes( aFormatter, aSimOptions );
96 writeModels( aFormatter );
97
98 // Skip this if there is no netlist to avoid an ngspice segfault
99 if( !m_items.empty() )
100 WriteDirectives( aSimCommand, aSimOptions, aFormatter );
101
102 writeItems( aFormatter );
103
104 WriteTail( aFormatter, aSimOptions );
105
106 return result;
107}
108
109
110void NETLIST_EXPORTER_SPICE::WriteHead( OUTPUTFORMATTER& aFormatter, unsigned aNetlistOptions )
111{
112 aFormatter.Print( 0, ".title KiCad schematic\n" );
113}
114
115
116void NETLIST_EXPORTER_SPICE::WriteTail( OUTPUTFORMATTER& aFormatter, unsigned aNetlistOptions )
117{
118 aFormatter.Print( 0, ".end\n" );
119}
120
121
123 REPORTER& aReporter )
124{
125 std::set<std::string> refNames; // Set of reference names to check for duplication.
126 int ncCounter = 1;
127
128 ReadDirectives( aNetlistOptions );
129
130 m_nets.clear();
131 m_items.clear();
133 m_libParts.clear();
134
135 wxFileName cacheDir;
136 cacheDir.AssignDir( PATHS::GetUserCachePath() );
137 cacheDir.AppendDir( wxT( "ibis" ) );
138
139 if( !cacheDir.DirExists() )
140 {
141 cacheDir.Mkdir( wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL );
142
143 if( !cacheDir.DirExists() )
144 {
145 wxLogTrace( wxT( "IBIS_CACHE:" ),
146 wxT( "%s:%s:%d\n * failed to create ibis cache directory '%s'" ),
147 __FILE__, __FUNCTION__, __LINE__, cacheDir.GetPath() );
148
149 return false;
150 }
151 }
152
153 wxDir dir;
154 wxString dirName = cacheDir.GetFullPath();
155
156 if( !dir.Open( dirName ) )
157 return false;
158
159 wxFileName thisFile;
160 wxArrayString fileList;
161 wxString fileSpec = wxT( "*.cache" );
162
163 thisFile.SetPath( dirName ); // Set the base path to the cache folder
164
165 size_t numFilesFound = wxDir::GetAllFiles( dirName, &fileList, fileSpec );
166
167 for( size_t ii = 0; ii < numFilesFound; ii++ )
168 {
169 // Completes path to specific file so we can get its "last access" date
170 thisFile.SetFullName( fileList[ii] );
171 wxRemoveFile( thisFile.GetFullPath() );
172 }
173
174 for( SCH_SHEET_PATH& sheet : BuildSheetList( aNetlistOptions ) )
175 {
176 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
177 {
178 SCH_SYMBOL* symbol = findNextSymbol( item, sheet );
179
180 if( !symbol || symbol->ResolveExcludedFromSim() )
181 continue;
182
183 try
184 {
185 SPICE_ITEM spiceItem;
186 std::vector<PIN_INFO> pins = CreatePinList( symbol, sheet, true );
187
188 for( const SCH_FIELD& field : symbol->GetFields() )
189 {
190 spiceItem.fields.emplace_back( symbol, FIELD_T::USER, field.GetName() );
191
192 if( field.GetId() == FIELD_T::REFERENCE )
193 spiceItem.fields.back().SetText( symbol->GetRef( &sheet ) );
194 else
195 spiceItem.fields.back().SetText( field.GetShownText( &sheet, false ) );
196 }
197
198 readRefName( sheet, *symbol, spiceItem, refNames );
199 readModel( sheet, *symbol, spiceItem, aReporter );
200 readPinNumbers( *symbol, spiceItem, pins );
201 readPinNetNames( *symbol, spiceItem, pins, ncCounter );
202 readNodePattern( spiceItem );
203 // TODO: transmission line handling?
204
205 m_items.push_back( std::move( spiceItem ) );
206 }
207 catch( IO_ERROR& e )
208 {
209 aReporter.Report( e.What(), RPT_SEVERITY_ERROR );
210 }
211 }
212 }
213
215}
216
217
219{
220 MARKUP::MARKUP_PARSER markupParser( aNetName->ToStdString() );
221 std::unique_ptr<MARKUP::NODE> root = markupParser.Parse();
222
223 std::function<void( const std::unique_ptr<MARKUP::NODE>&)> convertMarkup =
224 [&]( const std::unique_ptr<MARKUP::NODE>& aNode )
225 {
226 if( aNode )
227 {
228 if( !aNode->is_root() )
229 {
230 if( aNode->isOverbar() )
231 {
232 // ~{CLK} is a different signal than CLK
233 *aNetName += '~';
234 }
235 else if( aNode->isSubscript() || aNode->isSuperscript() )
236 {
237 // V_{OUT} is just a pretty-printed version of VOUT
238 }
239
240 if( aNode->has_content() )
241 *aNetName += aNode->string();
242 }
243
244 for( const std::unique_ptr<MARKUP::NODE>& child : aNode->children )
245 convertMarkup( child );
246 }
247 };
248
249 *aNetName = wxEmptyString;
250 convertMarkup( root );
251
252 // Replace all ngspice-disallowed chars in netnames by a '_'
253 aNetName->Replace( '%', '_' );
254 aNetName->Replace( '(', '_' );
255 aNetName->Replace( ')', '_' );
256 aNetName->Replace( ',', '_' );
257 aNetName->Replace( '[', '_' );
258 aNetName->Replace( ']', '_' );
259 aNetName->Replace( '<', '_' );
260 aNetName->Replace( '>', '_' );
261 aNetName->Replace( '~', '_' );
262 aNetName->Replace( ' ', '_' );
263
264 // A net name on the root sheet with a label '/foo' is going to get titled "//foo". This
265 // will trip up ngspice as "//" opens a line comment.
266 if( aNetName->StartsWith( wxS( "//" ) ) )
267 aNetName->Replace( wxS( "//" ), wxS( "/root/" ), false /* replace all */ );
268}
269
270
271wxString NETLIST_EXPORTER_SPICE::GetItemName( const wxString& aRefName ) const
272{
273 if( const SPICE_ITEM* item = FindItem( aRefName ) )
274 return item->model->SpiceGenerator().ItemName( *item );
275
276 return wxEmptyString;
277}
278
279
280const SPICE_ITEM* NETLIST_EXPORTER_SPICE::FindItem( const wxString& aRefName ) const
281{
282 const std::string refName = aRefName.ToStdString();
283 const std::list<SPICE_ITEM>& spiceItems = GetItems();
284
285 auto it = std::find_if( spiceItems.begin(), spiceItems.end(),
286 [&refName]( const SPICE_ITEM& item )
287 {
288 return item.refName == refName;
289 } );
290
291 if( it != spiceItems.end() )
292 return &*it;
293
294 return nullptr;
295}
296
297
298void NETLIST_EXPORTER_SPICE::ReadDirectives( unsigned aNetlistOptions )
299{
300 wxString text;
301
302 m_directives.clear();
303
304 for( const SCH_SHEET_PATH& sheet : BuildSheetList( aNetlistOptions ) )
305 {
306 for( SCH_ITEM* item : sheet.LastScreen()->Items() )
307 {
308 if( item->ResolveExcludedFromSim() )
309 continue;
310
311 if( item->Type() == SCH_TEXT_T )
312 text = static_cast<SCH_TEXT*>( item )->GetShownText( &sheet, false );
313 else if( item->Type() == SCH_TEXTBOX_T )
314 text = static_cast<SCH_TEXTBOX*>( item )->GetShownText( nullptr, &sheet, false );
315 else
316 continue;
317
318 // Send anything that contains directives to SPICE
319 wxStringTokenizer tokenizer( text, wxT( "\r\n" ), wxTOKEN_STRTOK );
320 bool foundDirective = false;
321
322 auto isDirective =
323 []( const wxString& line, const wxString& dir )
324 {
325 return line == dir || line.StartsWith( dir + wxS( " " ) );
326 };
327
328 while( tokenizer.HasMoreTokens() )
329 {
330 wxString line = tokenizer.GetNextToken().Upper();
331
332 if( line.StartsWith( wxT( "." ) ) )
333 {
334 if( isDirective( line, wxS( ".AC" ) )
335 || isDirective( line, wxS( ".CONTROL" ) )
336 || isDirective( line, wxS( ".CSPARAM" ) )
337 || isDirective( line, wxS( ".DISTO" ) )
338 || isDirective( line, wxS( ".DC" ) )
339 || isDirective( line, wxS( ".ELSE" ) )
340 || isDirective( line, wxS( ".ELSEIF" ) )
341 || isDirective( line, wxS( ".END" ) )
342 || isDirective( line, wxS( ".ENDC" ) )
343 || isDirective( line, wxS( ".ENDIF" ) )
344 || isDirective( line, wxS( ".ENDS" ) )
345 || isDirective( line, wxS( ".FOUR" ) )
346 || isDirective( line, wxS( ".FUNC" ) )
347 || isDirective( line, wxS( ".GLOBAL" ) )
348 || isDirective( line, wxS( ".IC" ) )
349 || isDirective( line, wxS( ".IF" ) )
350 || isDirective( line, wxS( ".INCLUDE" ) )
351 || isDirective( line, wxS( ".LIB" ) )
352 || isDirective( line, wxS( ".MEAS" ) )
353 || isDirective( line, wxS( ".MODEL" ) )
354 || isDirective( line, wxS( ".NODESET" ) )
355 || isDirective( line, wxS( ".NOISE" ) )
356 || isDirective( line, wxS( ".OP" ) )
357 || isDirective( line, wxS( ".OPTIONS" ) )
358 || isDirective( line, wxS( ".PARAM" ) )
359 || isDirective( line, wxS( ".PLOT" ) )
360 || isDirective( line, wxS( ".PRINT" ) )
361 || isDirective( line, wxS( ".PROBE" ) )
362 || isDirective( line, wxS( ".PZ" ) )
363 || isDirective( line, wxS( ".SAVE" ) )
364 || isDirective( line, wxS( ".SENS" ) )
365 || isDirective( line, wxS( ".SP" ) )
366 || isDirective( line, wxS( ".SUBCKT" ) )
367 || isDirective( line, wxS( ".TEMP" ) )
368 || isDirective( line, wxS( ".TF" ) )
369 || isDirective( line, wxS( ".TITLE" ) )
370 || isDirective( line, wxS( ".TRAN" ) )
371 || isDirective( line, wxS( ".WIDTH" ) ) )
372 {
373 foundDirective = true;
374 break;
375 }
376 }
377 else if( line.StartsWith( wxT( "K" ) ) )
378 {
379 // Check for mutual inductor declaration
380 wxStringTokenizer line_t( line, wxT( " \t" ), wxTOKEN_STRTOK );
381
382 // Coupling ID
383 if( !line_t.HasMoreTokens() || !line_t.GetNextToken().StartsWith( wxT( "K" ) ) )
384 continue;
385
386 // Inductor 1 ID
387 if( !line_t.HasMoreTokens() || !line_t.GetNextToken().StartsWith( wxT( "L" ) ) )
388 continue;
389
390 // Inductor 2 ID
391 if( !line_t.HasMoreTokens() || !line_t.GetNextToken().StartsWith( wxT( "L" ) ) )
392 continue;
393
394 // That's probably distinctive enough not to bother trying to parse the
395 // coupling value. If there's anything else, assume it's the value.
396 if( line_t.HasMoreTokens() )
397 {
398 foundDirective = true;
399 break;
400 }
401 }
402 }
403
404 if( foundDirective )
405 m_directives.emplace_back( text );
406 }
407 }
408}
409
410
412 SPICE_ITEM& aItem, std::set<std::string>& aRefNames )
413{
414 aItem.refName = aSymbol.GetRef( &aSheet );
415
416 if( !aRefNames.insert( aItem.refName ).second )
417 wxASSERT( wxT( "Duplicate refdes encountered; what happened to ReadyToNetlist()?" ) );
418}
419
420
422 SPICE_ITEM& aItem, REPORTER& aReporter )
423{
424 const SIM_LIBRARY::MODEL& libModel = m_libMgr.CreateModel( &aSheet, aSymbol, true, 0, aReporter );
425
426 aItem.baseModelName = libModel.name;
427 aItem.model = &libModel.model;
428
429 std::string modelName = aItem.model->SpiceGenerator().ModelName( aItem );
430 // Resolve model name collisions.
431 aItem.modelName = m_modelNameGenerator.Generate( modelName );
432
433 // FIXME: Don't have special cases for raw Spice models and KIBIS.
434 if( auto rawSpiceModel = dynamic_cast<const SIM_MODEL_RAW_SPICE*>( aItem.model ) )
435 {
436 int libParamIndex = static_cast<int>( SIM_MODEL_RAW_SPICE::SPICE_PARAM::LIB );
437 wxString path = rawSpiceModel->GetParam( libParamIndex ).value;
438
439 if( !path.IsEmpty() )
440 m_rawIncludes.insert( path );
441 }
442 else if( auto ibisModel = dynamic_cast<const SIM_MODEL_IBIS*>( aItem.model ) )
443 {
444 wxFileName cacheFn;
445 cacheFn.AssignDir( PATHS::GetUserCachePath() );
446 cacheFn.AppendDir( wxT( "ibis" ) );
447 cacheFn.SetFullName( aSymbol.GetRef( &aSheet ) + wxT( ".cache" ) );
448
449 wxFile cacheFile( cacheFn.GetFullPath(), wxFile::write );
450
451 if( !cacheFile.IsOpened() )
452 {
453 wxLogError( _( "Could not open file '%s' to write IBIS model" ),
454 cacheFn.GetFullPath() );
455 }
456
457 auto spiceGenerator = static_cast<const SPICE_GENERATOR_IBIS&>( ibisModel->SpiceGenerator() );
458
459 wxString cacheFilepath = cacheFn.GetPath( wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR );
460 std::string modelData = spiceGenerator.IbisDevice( aItem, m_schematic,
461 cacheFilepath, aReporter );
462
463 cacheFile.Write( wxString( modelData ) );
464 m_rawIncludes.insert( cacheFn.GetFullPath() );
465 }
466}
467
468
470 const std::vector<PIN_INFO>& aPins )
471{
472 for( const PIN_INFO& pin : aPins )
473 aItem.pinNumbers.emplace_back( pin.num.ToStdString() );
474}
475
476
478 const std::vector<PIN_INFO>& aPins, int& aNcCounter )
479{
480 for( const PIN_INFO& pinInfo : aPins )
481 {
482 wxString netName = GenerateItemPinNetName( pinInfo.netName, aNcCounter );
483
484 aItem.pinNetNames.push_back( netName.ToStdString() );
485 m_nets.insert( netName );
486 }
487}
488
489
491 std::vector<std::string>& aModifiers )
492{
493 std::string input = GetFieldValue( &aItem.fields, SIM_NODES_FORMAT_FIELD, true, 0 );
494
495 if( input == "" )
496 return;
497
498 tao::pegtl::string_input<> in( input, "Sim.NodesFormat field" );
499 std::unique_ptr<tao::pegtl::parse_tree::node> root;
500 std::string singleNodeModifier;
501
502 try
503 {
504 root = tao::pegtl::parse_tree::parse<SIM_XSPICE_PARSER_GRAMMAR::nodeSequenceGrammar,
506 tao::pegtl::nothing,
508 for( const auto& node : root->children )
509 {
510 if( node->is_type<SIM_XSPICE_PARSER_GRAMMAR::squareBracketC>() )
511 {
512 //we want ']' to close previous ?
513 aModifiers.back().append( node->string() );
514 }
515 else
516 { //rest goes to the new singleNodeModifier
517 singleNodeModifier.append( node->string() );
518 }
519
520 if( node->is_type<SIM_XSPICE_PARSER_GRAMMAR::nodeName>() )
521 {
522 aModifiers.push_back( singleNodeModifier );
523 singleNodeModifier.erase( singleNodeModifier.begin(), singleNodeModifier.end() );
524 }
525 }
526 }
527 catch( const tao::pegtl::parse_error& e )
528 {
529 THROW_IO_ERROR( wxString::Format( _( "Error in parsing model '%s', error: '%s'" ),
530 aItem.refName, e.what() ) );
531 }
532}
534{
535 std::vector<std::string> xspicePattern;
536 NETLIST_EXPORTER_SPICE::getNodePattern( aItem, xspicePattern );
537
538 if( xspicePattern.empty() )
539 return;
540
541 if( xspicePattern.size() != aItem.pinNetNames.size() )
542 {
543 THROW_IO_ERROR( wxString::Format( _( "Error in parsing model '%s', wrong number of nodes "
544 "'?' in Sim.NodesFormat compared to connections" ),
545 aItem.refName ) );
546 return;
547 }
548
549 auto itNetNames = aItem.pinNetNames.begin();
550
551 for( std::string& pattern : xspicePattern )
552 {
553 // ngspice does not care about aditional spaces, and we make sure that "%d?" is separated
554 const std::string netName = " " + *itNetNames + " ";
555 pattern.replace( pattern.find( "?" ), 1, netName );
556 *itNetNames = pattern;
557 ++itNetNames;
558 }
559}
560
561void NETLIST_EXPORTER_SPICE::writeInclude( OUTPUTFORMATTER& aFormatter, unsigned aNetlistOptions,
562 const wxString& aPath )
563{
564 // First, expand env vars, if any.
565 wxString expandedPath = ExpandEnvVarSubstitutions( aPath, &m_schematic->Project() );
566
567 // Path may have been authored by someone on a Windows box; convert it to UNIX format
568 expandedPath.Replace( '\\', '/' );
569
570 wxString fullPath;
571
572 if( aNetlistOptions & OPTION_ADJUST_INCLUDE_PATHS )
573 {
574 // Look for the library in known search locations.
575 fullPath = ResolveFile( expandedPath, &Pgm().GetLocalEnvVariables(), &m_schematic->Project() );
576
577 if( fullPath.IsEmpty() )
578 {
579 wxLogError( _( "Could not find library file '%s'" ), expandedPath );
580 fullPath = expandedPath;
581 }
582 else if( wxFileName::GetPathSeparator() == '\\' )
583 {
584 // Convert it to UNIX format (again) if ResolveFile() returned a Windows style path
585 fullPath.Replace( '\\', '/' );
586 }
587 }
588 else
589 {
590 fullPath = expandedPath;
591 }
592
593 aFormatter.Print( 0, ".include \"%s\"\n", TO_UTF8( fullPath ) );
594}
595
596
597void NETLIST_EXPORTER_SPICE::writeIncludes( OUTPUTFORMATTER& aFormatter, unsigned aNetlistOptions )
598{
599 for( const auto& [path, library] : m_libMgr.GetLibraries() )
600 {
601 if( dynamic_cast<const SIM_LIBRARY_SPICE*>( &library.get() ) )
602 writeInclude( aFormatter, aNetlistOptions, path );
603 }
604
605 for( const wxString& path : m_rawIncludes )
606 writeInclude( aFormatter, aNetlistOptions, path );
607}
608
609
611{
612 for( const SPICE_ITEM& item : m_items )
613 {
614 if( !item.model->IsEnabled() )
615 continue;
616
617 aFormatter.Print( 0, "%s", item.model->SpiceGenerator().ModelLine( item ).c_str() );
618 }
619}
620
621
623{
624 for( const SPICE_ITEM& item : m_items )
625 {
626 if( !item.model->IsEnabled() )
627 continue;
628
629 aFormatter.Print( 0, "%s", item.model->SpiceGenerator().ItemLine( item ).c_str() );
630 }
631}
632
633
634void NETLIST_EXPORTER_SPICE::WriteDirectives( const wxString& aSimCommand, unsigned aSimOptions,
635 OUTPUTFORMATTER& aFormatter ) const
636{
637 if( aSimOptions & OPTION_SAVE_ALL_VOLTAGES )
638 aFormatter.Print( 0, ".save all\n" );
639
640 if( aSimOptions & OPTION_SAVE_ALL_CURRENTS )
641 aFormatter.Print( 0, ".probe alli\n" );
642
643 if( aSimOptions & OPTION_SAVE_ALL_DISSIPATIONS )
644 {
645 for( const SPICE_ITEM& item : m_items )
646 {
647 // ngspice (v39) does not support power measurement for XSPICE devices
648 // XPSICE devices are marked with 'A'
649 std::string itemName = item.model->SpiceGenerator().ItemName( item );
650
651 if( ( item.model->GetPinCount() >= 2 ) && ( itemName.size() > 0 )
652 && ( itemName.c_str()[0] != 'A' ) )
653 {
654 aFormatter.Print( 0, ".probe p(%s)\n", itemName.c_str() );
655 }
656 }
657 }
658
659 auto isSimCommand =
660 []( const wxString& candidate, const wxString& dir )
661 {
662 return candidate == dir || candidate.StartsWith( dir + wxS( " " ) );
663 };
664
665 for( const wxString& directive : m_directives )
666 {
667 bool simCommand = false;
668
669 if( directive.StartsWith( "." ) )
670 {
671 wxString candidate = directive.Upper();
672
673 simCommand = ( isSimCommand( candidate, wxS( ".AC" ) )
674 || isSimCommand( candidate, wxS( ".DC" ) )
675 || isSimCommand( candidate, wxS( ".TRAN" ) )
676 || isSimCommand( candidate, wxS( ".OP" ) )
677 || isSimCommand( candidate, wxS( ".DISTO" ) )
678 || isSimCommand( candidate, wxS( ".NOISE" ) )
679 || isSimCommand( candidate, wxS( ".PZ" ) )
680 || isSimCommand( candidate, wxS( ".SENS" ) )
681 || isSimCommand( candidate, wxS( ".TF" ) ) );
682 }
683
684 if( !simCommand || ( aSimOptions & OPTION_SIM_COMMAND ) )
685 aFormatter.Print( 0, "%s\n", UTF8( directive ).c_str() );
686 }
687}
688
689
690wxString NETLIST_EXPORTER_SPICE::GenerateItemPinNetName( const wxString& aNetName,
691 int& aNcCounter ) const
692{
693 wxString netName = UnescapeString( aNetName );
694
695 ConvertToSpiceMarkup( &netName );
696
697 if( netName.IsEmpty() )
698 netName.Printf( wxS( "NC-%d" ), aNcCounter++ );
699
700 return netName;
701}
702
703
705{
706 SCH_SHEET_LIST sheets;
707
708 if( aNetlistOptions & OPTION_CUR_SHEET_AS_ROOT )
710 else
711 sheets = m_schematic->Hierarchy();
712
713 std::erase_if( sheets,
714 [&]( const SCH_SHEET_PATH& sheet )
715 {
716 return sheet.GetExcludedFromSim();
717 } );
718
719 return sheets;
720}
721
const char * name
Definition: DXF_plotter.cpp:62
Used for text file output.
Definition: richio.h:491
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:77
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:41
std::unique_ptr< NODE > Parse()
std::unordered_set< std::string > m_names
std::string Generate(const std::string &aProposedName)
An abstract class used for the netlist exporters that Eeschema supports.
SCHEMATIC * m_schematic
The schematic we're generating a netlist for.
std::vector< PIN_INFO > CreatePinList(SCH_SYMBOL *aSymbol, const SCH_SHEET_PATH &aSheetPath, bool aKeepUnconnectedPins)
Find a symbol from the DrawList and builds its pin list.
SCH_SYMBOL * findNextSymbol(EDA_ITEM *aItem, const SCH_SHEET_PATH &aSheetPath)
Check if the given symbol should be processed for netlisting.
std::set< LIB_SYMBOL *, LIB_SYMBOL_LESS_THAN > m_libParts
unique library symbols used. LIB_SYMBOL items are sorted by names
UNIQUE_STRINGS m_referencesAlreadyFound
Used for "multiple symbols per package" symbols to avoid processing a lib symbol more than once.
void readPinNetNames(SCH_SYMBOL &aSymbol, SPICE_ITEM &aItem, const std::vector< PIN_INFO > &aPins, int &aNcCounter)
void writeModels(OUTPUTFORMATTER &aFormatter)
void writeIncludes(OUTPUTFORMATTER &aFormatter, unsigned aNetlistOptions)
std::list< SPICE_ITEM > m_items
void getNodePattern(SPICE_ITEM &aItem, std::vector< std::string > &aModifiers)
static void ConvertToSpiceMarkup(wxString *aNetName)
Remove formatting wrappers and replace illegal spice net name characters with underscores.
void ReadDirectives(unsigned aNetlistOptions)
SCH_SHEET_LIST BuildSheetList(unsigned aNetlistOptions=0) const
Return the paths of exported sheets (either all or the current one).
void readModel(SCH_SHEET_PATH &aSheet, SCH_SYMBOL &aSymbol, SPICE_ITEM &aItem, REPORTER &aReporter)
virtual wxString GenerateItemPinNetName(const wxString &aNetName, int &aNcCounter) const
std::set< wxString > m_nets
Items representing schematic symbols in Spice world.
void readRefName(SCH_SHEET_PATH &aSheet, SCH_SYMBOL &aSymbol, SPICE_ITEM &aItem, std::set< std::string > &aRefNames)
wxString GetItemName(const wxString &aRefName) const
Return name of Spice device corresponding to a schematic symbol.
void writeItems(OUTPUTFORMATTER &aFormatter)
std::vector< wxString > m_directives
Spice directives found in the schematic sheet.
virtual void WriteHead(OUTPUTFORMATTER &aFormatter, unsigned aNetlistOptions)
Write the netlist head (title and so on).
void writeInclude(OUTPUTFORMATTER &aFormatter, unsigned aNetlistOptions, const wxString &aPath)
virtual void WriteDirectives(const wxString &aSimCommand, unsigned aSimOptions, OUTPUTFORMATTER &candidate) const
NETLIST_EXPORTER_SPICE(SCHEMATIC *aSchematic)
SIM_LIB_MGR m_libMgr
Holds libraries and models.
const SPICE_ITEM * FindItem(const wxString &aRefName) const
Find and return the item corresponding to aRefName.
virtual bool ReadSchematicAndLibraries(unsigned aNetlistOptions, REPORTER &aReporter)
Process the schematic and Spice libraries to create net mapping and a list of SPICE_ITEMs.
bool DoWriteNetlist(const wxString &aSimCommand, unsigned aSimOptions, OUTPUTFORMATTER &aFormatter, REPORTER &aReporter)
Write the netlist in aFormatter.
void readPinNumbers(SCH_SYMBOL &aSymbol, SPICE_ITEM &aItem, const std::vector< PIN_INFO > &aPins)
const std::list< SPICE_ITEM > & GetItems() const
Return the list of items representing schematic symbols in the Spice world.
void readNodePattern(SPICE_ITEM &aItem)
std::set< wxString > m_rawIncludes
include directives found in symbols
virtual void WriteTail(OUTPUTFORMATTER &aFormatter, unsigned aNetlistOptions)
Write the tail (.end).
NAME_GENERATOR m_modelNameGenerator
Generates unique model names.
bool WriteNetlist(const wxString &aOutFileName, unsigned aNetlistOptions, REPORTER &aReporter) override
Write to specified output file.
An interface used to output 8 bit text in a convenient way.
Definition: richio.h:322
int PRINTF_FUNC_N Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:463
static wxString GetUserCachePath()
Gets the stock (install) 3d viewer plugins path.
Definition: paths.cpp:419
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:73
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
Report a string with a given severity.
Definition: reporter.h:102
virtual bool HasMessageOfSeverity(int aSeverityMask) const
Returns true if the reporter has one or more messages matching the specified severity mask.
Definition: reporter.h:140
Holds all the data relating to one schematic.
Definition: schematic.h:88
SCH_SHEET_LIST Hierarchy() const
Return the full schematic flattened hierarchical sheet list.
Definition: schematic.cpp:258
PROJECT & Project() const
Return a reference to the project this schematic is part of.
Definition: schematic.h:103
EMBEDDED_FILES * GetEmbeddedFiles() override
Definition: schematic.cpp:927
SCH_SHEET_PATH & CurrentSheet() const
Definition: schematic.h:171
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:168
bool ResolveExcludedFromSim() const
Definition: sch_item.cpp:276
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
bool GetExcludedFromSim() const
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
Schematic symbol object.
Definition: sch_symbol.h:75
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly) const override
Populate a std::vector with SCH_FIELDs, sorted in ordinal order.
Definition: sch_symbol.cpp:788
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const override
Definition: sch_symbol.cpp:558
virtual wxString GetShownText(const RENDER_SETTINGS *aSettings, const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const
SIM_MODEL & CreateModel(SIM_MODEL::TYPE aType, const std::vector< SCH_PIN * > &aPins, REPORTER &aReporter)
std::map< wxString, std::reference_wrapper< const SIM_LIBRARY > > GetLibraries() const
void SetFilesStack(std::vector< EMBEDDED_FILES * > aFilesStack)
Definition: sim_lib_mgr.h:48
const SPICE_GENERATOR & SpiceGenerator() const
Definition: sim_model.h:431
std::string IbisDevice(const SPICE_ITEM &aItem, SCHEMATIC *aSchematic, const wxString &aCacheDir, REPORTER &aReporter) const
virtual std::string ModelName(const SPICE_ITEM &aItem) const
void Clear()
Erase the record.
An 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to and fro...
Definition: utf8.h:72
const char * c_str() const
Definition: utf8.h:109
const wxString ExpandEnvVarSubstitutions(const wxString &aString, const PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition: common.cpp:355
The common library.
This file is part of the common library.
#define _(s)
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:166
Helper functions to substitute paths with environmental variables.
#define THROW_IO_ERROR(msg)
Definition: ki_exception.h:39
must_if< error >::control< Rule > control
PGM_BASE & Pgm()
The global program "get" accessor.
Definition: pgm_base.cpp:902
see class PGM_BASE
@ RPT_SEVERITY_ERROR
@ RPT_SEVERITY_UNDEFINED
wxString GetFieldValue(const std::vector< SCH_FIELD > *aFields, FIELD_T aFieldType)
Definition: sch_field.h:398
#define SIM_NODES_FORMAT_FIELD
Definition: sim_model.h:58
std::vector< FAB_LAYER_COLOR > dummy
wxString UnescapeString(const wxString &aSource)
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: string_utils.h:429
SIM_MODEL & model
Definition: sim_library.h:41
std::string name
Definition: sim_library.h:40
Notes: spaces are allowed everywhere in any number ~ can only be before ? ~~ is not allowed [] can en...
std::string refName
std::vector< SCH_FIELD > fields
std::string modelName
const SIM_MODEL * model
std::vector< std::string > pinNetNames
std::string baseModelName
std::vector< std::string > pinNumbers
@ SCH_SYMBOL_T
Definition: typeinfo.h:173
@ SCH_TEXT_T
Definition: typeinfo.h:152
@ SCH_TEXTBOX_T
Definition: typeinfo.h:153