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 <[email protected]>
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 <string_utils.h>
28#include <gestfich.h>
29#include <sch_edit_frame.h>
30#include <schematic.h>
31#include <reporter.h>
32#include <confirm.h>
33#include <kiway.h>
34#include <erc.h>
35
36#include <netlist.h>
44
45
46bool 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 = nullptr;
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
74 helper = new NETLIST_EXPORTER_ORCADPCB2( sch );
75 break;
76
78 helper = new NETLIST_EXPORTER_CADSTAR( sch );
79 break;
80
81 case NET_TYPE_SPICE:
82 helper = new NETLIST_EXPORTER_SPICE( sch );
83 break;
84
86 helper = new NETLIST_EXPORTER_SPICE_MODEL( sch );
87 break;
88
89 case NET_TYPE_BOM:
90 // When generating the BOM, we have a bare filename so don't strip
91 // the extension or you might string a '.' from the middle of the filename
92 fileName += wxT( "." GENERIC_INTERMEDIATE_NETLIST_EXT );
93
94 helper = new NETLIST_EXPORTER_XML( sch );
95 executeCommandLine = true;
96 break;
97
98 default:
99 {
100 wxFileName tmpFile = fileName;
101 tmpFile.SetExt( GENERIC_INTERMEDIATE_NETLIST_EXT );
102 fileName = tmpFile.GetFullPath();
103
104 helper = new NETLIST_EXPORTER_XML( sch );
105 executeCommandLine = true;
106 }
107 break;
108 }
109
110 res = helper->WriteNetlist( fileName, aNetlistOptions );
111 delete helper;
112
113 // If user provided a plugin command line, execute it.
114 if( executeCommandLine && res && !m_netListerCommand.IsEmpty() )
115 {
116 wxString prj_dir = Prj().GetProjectPath();
117
118 // strip trailing '/'
119 prj_dir = prj_dir.SubString( 0, prj_dir.Len() - 2 );
120
121 // build full command line from user's format string.
122 // For instance, "xsltproc -o %O /usr/local/lib/kicad/plugins/netlist_form_pads-pcb.xsl %I"
123 // becomes, after the user selects /tmp/s1.net as the output file from the file dialog:
124 // "xsltproc -o /tmp/s1.net /usr/local/lib/kicad/plugins/netlist_form_pads-pcb.xsl /tmp/s1.xml"
126 fileName, aFullFileName,
127 prj_dir );
128
129 if( aReporter )
130 {
131 wxArrayString output, errors;
132 int diag = wxExecute( commandLine, output, errors, m_exec_flags );
133 wxString msg;
134
135 aReporter->ReportHead( commandLine, RPT_SEVERITY_ACTION );
136
137 if( diag != 0 )
138 {
139 msg.Printf( _( "Command error. Return code %d." ), diag );
140 aReporter->ReportTail( msg, RPT_SEVERITY_ERROR );
141 }
142 else
143 {
144 aReporter->ReportTail( _( "Success." ), RPT_SEVERITY_INFO );
145 }
146
147 if( output.GetCount() )
148 {
149 for( unsigned ii = 0; ii < output.GetCount(); ii++ )
150 aReporter->Report( output[ii], RPT_SEVERITY_INFO );
151 }
152
153 if( errors.GetCount() )
154 {
155 for( unsigned ii = 0; ii < errors.GetCount(); ii++ )
156 aReporter->Report( errors[ii], RPT_SEVERITY_ERROR );
157 }
158 }
159 else
160 {
161 wxExecute( commandLine, m_exec_flags );
162 }
163
164 DefaultExecFlags(); // Reset flags to default after executing
165 }
166
167 return res;
168}
169
170
171bool SCH_EDIT_FRAME::ReadyToNetlist( const wxString& aAnnotateMessage )
172{
173 // Ensure all power symbols have a valid reference
175
176 // Symbols must be annotated
177 if( CheckAnnotate( []( ERCE_T, const wxString&, SCH_REFERENCE*, SCH_REFERENCE* ) {} ) )
178 {
179 // Schematic must be annotated: call Annotate dialog and tell the user why.
180 ModalAnnotate( aAnnotateMessage );
181
182 if( CheckAnnotate( []( ERCE_T, const wxString&, SCH_REFERENCE*, SCH_REFERENCE* ) {} ) )
183 return false;
184 }
185
186 // Test duplicate sheet names:
188
189 if( erc.TestDuplicateSheetNames( false ) > 0 )
190 {
191 if( !IsOK( this, _( "Error: duplicate sheet names. Continue?" ) ) )
192 return false;
193 }
194
195 return true;
196}
197
198
200{
201 std::string packet;
202
203 {
204 NETLIST_EXPORTER_KICAD exporter( &Schematic() );
205 STRING_FORMATTER formatter;
206
207 // @todo : trim GNL_ALL down to minimum for CVPCB
208 exporter.Format( &formatter, GNL_ALL | GNL_OPT_KICAD );
209
210 packet = formatter.GetString(); // an abbreviated "kicad" (s-expr) netlist
211
212 // NETLIST_EXPORTER_KICAD must go out of scope so it can clean up things like the
213 // current sheet setting before sending expressmail
214 }
215
217}
218
Definition: erc.h:48
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
Send aPayload to aDestination from aSource.
Definition: kiway.cpp:488
An abstract class used for the netlist exporters that Eeschema supports.
virtual bool WriteNetlist(const wxString &aOutFileName, unsigned aNetlistOptions)
Write to specified output file.
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.
Generate a netlist compatible with CADSTAR.
Generate the KiCad netlist format supported by Pcbnew.
void Format(OUTPUTFORMATTER *aOutputFormatter, int aCtl)
Output this s-expression netlist into aOutputFormatter.
Generate a netlist compatible with OrCAD.
Generate a generic XML based netlist file.
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:125
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71
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:108
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:99
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.
Holds all the data relating to one schematic.
Definition: schematic.h:60
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:85
void DefaultExecFlags()
Reset the execution flags to defaults for external netlist and bom generators.
bool ReadyToNetlist(const wxString &aAnnotateMessage)
Check if we are ready to write a netlist file for the current schematic.
bool WriteNetListFile(int aFormat, const wxString &aFullFileName, unsigned aNetlistOptions, REPORTER *aReporter=nullptr)
Create a netlist file.
SCHEMATIC & Schematic() const
int m_exec_flags
Flags of the wxExecute() function to call a custom net list generator.
void sendNetlistToCvpcb()
Send the KiCad netlist over to CVPCB.
void RecalculateConnections(SCH_CLEANUP_FLAGS aCleanupFlags)
Generate the connection data for the entire schematic hierarchy.
int CheckAnnotate(ANNOTATION_ERROR_HANDLER aErrorHandler, ANNOTATE_SCOPE_T aAnnotateScope=ANNOTATE_ALL, bool aRecursive=true)
Check for annotation errors.
Definition: annotate.cpp:441
int ModalAnnotate(const wxString &aMessage)
Run a modal version of the annotate dialog for a specific purpose.
wxString m_netListerCommand
Command line to call a custom net list generator.
A helper to define a symbol's reference designator in a schematic.
void AnnotatePowerSymbols()
Silently annotate the not yet annotated power symbols of the entire hierarchy of the sheet path list.
Implement an OUTPUTFORMATTER to a memory buffer.
Definition: richio.h:415
const std::string & GetString()
Definition: richio.h:438
The common library.
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:342
This file is part of the common library.
#define _(s)
ERCE_T
ERC error codes.
Definition: erc_settings.h:37
@ FRAME_CVPCB
Definition: frame_type.h:48
@ MAIL_EESCHEMA_NETLIST
Definition: mail_type.h:44
@ NET_TYPE_BOM
Definition: netlist.h:37
@ NET_TYPE_CADSTAR
Definition: netlist.h:40
@ NET_TYPE_ORCADPCB2
Definition: netlist.h:39
@ NET_TYPE_SPICE
Definition: netlist.h:41
@ NET_TYPE_SPICE_MODEL
Definition: netlist.h:42
@ NET_TYPE_PCBNEW
Definition: netlist.h:38
#define GNL_ALL
#define GENERIC_INTERMEDIATE_NETLIST_EXT
@ GNL_OPT_KICAD
@ RPT_SEVERITY_ERROR
@ RPT_SEVERITY_INFO
@ RPT_SEVERITY_ACTION
@ NO_CLEANUP