KiCad PCB EDA Suite
netlist_exporter_generic.h
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
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 #ifndef NETLIST_EXPORT_GENERIC_H
27 #define NETLIST_EXPORT_GENERIC_H
28 
29 #include <netlist_exporter.h>
30 
31 #include <project.h>
32 #include <xnode.h> // also nests: <wx/xml/xml.h>
33 
34 #include <sch_edit_frame.h>
35 
36 class CONNECTION_GRAPH;
37 class SYMBOL_LIB_TABLE;
38 
39 #define GENERIC_INTERMEDIATE_NETLIST_EXT wxT( "xml" )
40 
44 enum GNL_T
45 {
46  GNL_LIBRARIES = 1 << 0,
47  GNL_COMPONENTS = 1 << 1,
48  GNL_PARTS = 1 << 2,
49  GNL_HEADER = 1 << 3,
50  GNL_NETS = 1 << 4,
51  GNL_OPT_KICAD = 1 << 5,
52  GNL_OPT_BOM = 1 << 6,
53 };
54 
55 
63 {
64 private:
65  std::set< wxString > m_libraries;
66 
67 public:
69  NETLIST_EXPORTER( aSchematic )
70  {}
71 
80  bool WriteNetlist( const wxString& aOutFileName, unsigned aNetlistOptions ) override;
81 
82 #define GNL_ALL ( GNL_LIBRARIES | GNL_COMPONENTS | GNL_PARTS | GNL_HEADER | GNL_NETS )
83 
84 protected:
93  XNODE* node( const wxString& aName, const wxString& aTextualContent = wxEmptyString );
94 
102  XNODE* makeRoot( int aCtl = GNL_ALL );
103 
107  XNODE* makeComponents( unsigned aCtl );
108 
114 
119  XNODE* makeLibParts();
120 
126 
132  XNODE* makeLibraries();
133 
134  void addComponentFields( XNODE* xcomp, SCH_COMPONENT* comp, SCH_SHEET_PATH* aSheet );
135 };
136 
137 #endif
bool WriteNetlist(const wxString &aOutFileName, unsigned aNetlistOptions) override
Write generic netlist to aOutFileName.
XNODE * node(const wxString &aName, const wxString &aTextualContent=wxEmptyString)
A convenience function that creates a new XNODE with an optional textual child.
Holds all the data relating to one schematic A schematic may consist of one or more sheets (and one r...
Definition: schematic.h:42
Calculates the connectivity of a schematic and generates netlists.
XNODE * makeRoot(int aCtl=GNL_ALL)
Build the entire document tree for the generic export.
std::set< wxString > m_libraries
Set of library nicknames.
NETLIST_EXPORTER is a abstract class used for the netlist exporters that eeschema supports.
GNL_T
A set of bits which control the totality of the tree built by makeRoot()
void addComponentFields(XNODE *xcomp, SCH_COMPONENT *comp, SCH_SHEET_PATH *aSheet)
Generate a generic XML based netlist file.
XNODE * makeDesignHeader()
Fills out a project "design" header into an XML node.
SCH_SHEET_PATH.
XNODE * makeComponents(unsigned aCtl)
XNODE holds an XML or S-expression element.
Definition: xnode.h:43
#define GNL_ALL
Schematic symbol object.
Definition: sch_component.h:88
XNODE * makeLibraries()
Fill out an XML node with a list of used libraries and returns it.
XNODE * makeListOfNets()
Fill out an XML node with a list of nets and returns it.
NETLIST_EXPORTER_GENERIC(SCHEMATIC *aSchematic)
XNODE * makeLibParts()
Fill out an XML node with the unique library parts and returns it.