KiCad PCB EDA Suite
netlist_generator.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-2018 jp.charras at wanadoo.fr
5  * Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 1992-2021 KiCad Developers, see change_log.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 <common.h> // for ProcessExecute
27 #include <kicad_string.h>
28 #include <gestfich.h>
29 #include <pgm_base.h>
30 #include <sch_edit_frame.h>
31 #include <schematic.h>
32 #include <reporter.h>
33 #include <confirm.h>
34 #include <kiway.h>
35 #include <erc.h>
36 
37 #include <netlist.h>
38 #include <netlist_exporter_base.h>
42 #include <netlist_exporter_kicad.h>
43 #include <netlist_exporter_xml.h>
44 
45 
46 bool SCH_EDIT_FRAME::WriteNetListFile( int aFormat, const wxString& aFullFileName,
47  unsigned aNetlistOptions, REPORTER* aReporter )
48 {
49  // Ensure all power symbols have a valid reference
51 
52  // Ensure the netlist data is up to date:
54 
55  if( !ReadyToNetlist( _( "Exporting netlist requires a fully annotated schematic." ) ) )
56  return false;
57 
58  bool res = true;
59  bool executeCommandLine = false;
60 
61  wxString fileName = aFullFileName;
62 
63  NETLIST_EXPORTER_BASE *helper;
64 
65  SCHEMATIC* sch = &Schematic();
66 
67  switch( aFormat )
68  {
69  case NET_TYPE_PCBNEW:
70  helper = new NETLIST_EXPORTER_KICAD( sch );
71  break;
72 
73  case NET_TYPE_ORCADPCB2:
74  helper = new NETLIST_EXPORTER_ORCADPCB2( sch );
75  break;
76 
77  case NET_TYPE_CADSTAR:
78  helper = new NETLIST_EXPORTER_CADSTAR( sch );
79  break;
80 
81  case NET_TYPE_SPICE:
82  helper = new NETLIST_EXPORTER_PSPICE( sch );
83  break;
84 
85  default:
86  {
87  wxFileName tmpFile = fileName;
88  tmpFile.SetExt( GENERIC_INTERMEDIATE_NETLIST_EXT );
89  fileName = tmpFile.GetFullPath();
90 
91  helper = new NETLIST_EXPORTER_XML( sch );
92  executeCommandLine = true;
93  }
94  break;
95  }
96 
97  res = helper->WriteNetlist( fileName, aNetlistOptions );
98  delete helper;
99 
100  // If user provided a plugin command line, execute it.
101  if( executeCommandLine && res && !m_netListerCommand.IsEmpty() )
102  {
103  wxString prj_dir = Prj().GetProjectPath();
104 
105  // strip trailing '/'
106  prj_dir = prj_dir.SubString( 0, prj_dir.Len() - 2 );
107 
108  // build full command line from user's format string.
109  // For instance, "xsltproc -o %O /usr/local/lib/kicad/plugins/netlist_form_pads-pcb.xsl %I"
110  // becomes, after the user selects /tmp/s1.net as the output file from the file dialog:
111  // "xsltproc -o /tmp/s1.net /usr/local/lib/kicad/plugins/netlist_form_pads-pcb.xsl /tmp/s1.xml"
113  fileName, aFullFileName,
114  prj_dir );
115 
116  if( aReporter )
117  {
118  wxArrayString output, errors;
119  int diag = wxExecute( commandLine, output, errors, m_exec_flags );
120 
121  wxString msg;
122 
123  msg << _( "Run command:" ) << wxT( "\n" ) << commandLine << wxT( "\n\n" );
124  aReporter->ReportHead( msg, RPT_SEVERITY_ACTION );
125 
126  if( diag != 0 )
127  {
128  msg.Printf( _( "Command error. Return code %d." ), diag );
129  aReporter->ReportTail( msg, RPT_SEVERITY_ERROR );
130  }
131  else
132  {
133  aReporter->ReportTail( _( "Success." ), RPT_SEVERITY_INFO );
134  }
135 
136  if( output.GetCount() )
137  {
138  msg.Empty();
139  msg << wxT( "\n" ) << _( "Info messages:" ) << wxT( "\n" );
140  aReporter->Report( msg, RPT_SEVERITY_INFO );
141 
142  for( unsigned ii = 0; ii < output.GetCount(); ii++ )
143  aReporter->Report( output[ii] + wxT( "\n" ), RPT_SEVERITY_INFO );
144  }
145 
146  if( errors.GetCount() )
147  {
148  msg.Empty();
149  msg << wxT("\n") << _( "Error messages:" ) << wxT( "\n" );
150  aReporter->Report( msg, RPT_SEVERITY_INFO );
151 
152  for( unsigned ii = 0; ii < errors.GetCount(); ii++ )
153  aReporter->Report( errors[ii] + wxT( "\n" ), RPT_SEVERITY_ERROR );
154  }
155  }
156  else
157  {
158  ProcessExecute( commandLine, m_exec_flags );
159  }
160 
161  DefaultExecFlags(); // Reset flags to default after executing
162  }
163 
164  return res;
165 }
166 
167 
168 bool SCH_EDIT_FRAME::ReadyToNetlist( const wxString& aAnnotateMessage )
169 {
170  // Ensure all power symbols have a valid reference
172 
173  // Components must be annotated
174  if( CheckAnnotate( []( ERCE_T, const wxString&, SCH_REFERENCE*, SCH_REFERENCE* ) {} ) )
175  {
176  // Schematic must be annotated: call Annotate dialog and tell the user why.
177  ModalAnnotate( aAnnotateMessage );
178 
179  if( CheckAnnotate( []( ERCE_T, const wxString&, SCH_REFERENCE*, SCH_REFERENCE* ) {} ) )
180  return false;
181  }
182 
183  // Test duplicate sheet names:
184  ERC_TESTER erc( &Schematic() );
185 
186  if( erc.TestDuplicateSheetNames( false ) > 0 )
187  {
188  if( !IsOK( this, _( "Error: duplicate sheet names. Continue?" ) ) )
189  return false;
190  }
191 
192  return true;
193 }
194 
195 
197 {
198  std::string packet;
199 
200  {
201  NETLIST_EXPORTER_KICAD exporter( &Schematic() );
202  STRING_FORMATTER formatter;
203 
204  // @todo : trim GNL_ALL down to minimum for CVPCB
205  exporter.Format( &formatter, GNL_ALL );
206 
207  packet = formatter.GetString(); // an abbreviated "kicad" (s-expr) netlist
208 
209  // NETLIST_EXPORTER_KICAD must go out of scope so it can clean up things like the
210  // current sheet setting before sending expressmail
211  }
212 
214 }
215 
bool ReadyToNetlist(const wxString &aAnnotateMessage)
Check if we are ready to write a netlist file for the current schematic.
wxString m_netListerCommand
Command line to call a custom net list generator.
void DefaultExecFlags()
Reset the execution flags to defaults for external netlist and bom generators.
int ProcessExecute(const wxString &aCommandLine, int aFlags, wxProcess *callback)
Run a command in a child process.
Definition: common.cpp:40
virtual bool WriteNetlist(const wxString &aOutFileName, unsigned aNetlistOptions)
Write to specified output file.
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
This file is part of the common library TODO brief description.
void RecalculateConnections(SCH_CLEANUP_FLAGS aCleanupFlags)
Generate the connection data for the entire schematic hierarchy.
Holds all the data relating to one schematic.
Definition: schematic.h:59
This file is part of the common library.
virtual REPORTER & ReportTail(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
Places the report at the end of the list, for objects that support report ordering.
Definition: reporter.h:93
Definition: erc.h:47
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
Send aPayload to aDestination from aSource.
Definition: kiway.cpp:462
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:64
void Format(OUTPUTFORMATTER *aOutputFormatter, int aCtl)
Output this s-expression netlist into aOutputFormatter.
int CheckAnnotate(ANNOTATION_ERROR_HANDLER aErrorHandler, ANNOTATE_SCOPE_T aAnnotateScope=ANNOTATE_ALL)
Check for annotation errors.
Definition: annotate.cpp:334
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:123
static wxString MakeCommandLine(const wxString &aFormatString, const wxString &aNetlistFile, const wxString &aFinalFile, const wxString &aProjectDirectory)
Build up a string that describes a command line for executing a child process.
bool WriteNetListFile(int aFormat, const wxString &aFullFileName, unsigned aNetlistOptions, REPORTER *aReporter=nullptr)
Create a netlist file.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Generate the KiCad netlist format supported by Pcbnew.
SCHEMATIC & Schematic() const
const std::string & GetString()
Definition: richio.h:435
#define GNL_ALL
ERCE_T
ERC error codes.
Definition: erc_settings.h:36
An abstract class used for the netlist exporters that Eeschema supports.
virtual REPORTER & ReportHead(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
Places the report at the beginning of the list for objects that support ordering.
Definition: reporter.h:102
Generate a netlist compatible with CADSTAR.
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:87
Generate a netlist compatible with OrCAD.
int ModalAnnotate(const wxString &aMessage)
Run a modal version of the annotate dialog for a specific purpose.
see class PGM_BASE
#define _(s)
Definition: 3d_actions.cpp:33
Generate a PSPICE compatible netlist.
The common library.
void AnnotatePowerSymbols()
Silently annotate the not yet annotated power symbols of the entire hierarchy of the sheet path list.
#define GENERIC_INTERMEDIATE_NETLIST_EXT
int m_exec_flags
Flags of the wxExecute() function to call a custom net list generator.
Generate a generic XML based netlist file.
Implement an OUTPUTFORMATTER to a memory buffer.
Definition: richio.h:411
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:296
A helper to define a symbol's reference designator in a schematic.
void sendNetlistToCvpcb()
Send the KiCad netlist over to CVPCB.