KiCad PCB EDA Suite
netlist_exporter_kicad.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-2020 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 
27 #include <algorithm>
28 #include <fctsys.h>
29 #include <build_version.h>
30 #include <confirm.h>
31 
32 #include <sch_edit_frame.h>
33 #include <xnode.h>
34 #include <connection_graph.h>
35 #include "netlist_exporter_kicad.h"
36 
37 bool NETLIST_EXPORTER_KICAD::WriteNetlist( const wxString& aOutFileName, unsigned aNetlistOptions )
38 {
39  try
40  {
41  FILE_OUTPUTFORMATTER formatter( aOutFileName );
42  Format( &formatter, GNL_ALL | GNL_OPT_KICAD );
43  }
44 
45  catch( const IO_ERROR& ioe )
46  {
47  DisplayError( NULL, ioe.What() );
48  return false;
49  }
50 
51  return true;
52 }
53 
54 
56 {
57  std::unique_ptr<XNODE> xroot( makeRoot( aCtl ) );
58 
59  xroot->Format( aOut, 0 );
60 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
This file is part of the common library.
OUTPUTFORMATTER is an important interface (abstract class) used to output 8 bit text in a convenient ...
Definition: richio.h:327
void Format(OUTPUTFORMATTER *aOutputFormatter, int aCtl)
Output this s-expression netlist into aOutputFormatter.
XNODE * makeRoot(int aCtl=GNL_ALL)
Build the entire document tree for the generic export.
#define NULL
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
bool WriteNetlist(const wxString &aOutFileName, unsigned aNetlistOptions) override
Write netlist to aOutFileName.
#define GNL_ALL
FILE_OUTPUTFORMATTER may be used for text file output.
Definition: richio.h:492
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76